1 #LyX 1.6.0svn created this file. For more info see http://www.lyx.org/
13 \font_typewriter default
14 \font_default_family default
21 \paperfontsize default
29 \paperorientation portrait
36 \paragraph_separation indent
38 \quotes_language english
41 \paperpagestyle default
42 \tracking_changes false
50 \begin_layout Section*
51 LFUNs documentation automatically generated 08.09.2008.
54 \begin_layout Standard
58 \begin_layout Plain Layout
68 \begin_inset VSpace 1cm
74 \begin_layout Subsection*
78 \begin_layout Description
79 Action Adds an acute accent to the next character typed.
83 \begin_layout Description
87 \begin_layout Subsection*
91 \begin_layout Description
92 Action Adds a breve accent to the next character typed.
96 \begin_layout Description
100 \begin_layout Subsection*
104 \begin_layout Description
105 Action Adds a caron to the next character typed.
109 \begin_layout Description
113 \begin_layout Subsection*
117 \begin_layout Description
118 Action Adds a cedilla to the next character typed.
122 \begin_layout Description
123 Syntax accent-cedilla
126 \begin_layout Subsection*
130 \begin_layout Description
131 Action Adds a circle accent to the next character typed.
135 \begin_layout Description
139 \begin_layout Subsection*
140 LFUN_ACCENT_CIRCUMFLEX
143 \begin_layout Description
144 Action Adds a circumflex to the next character typed.
148 \begin_layout Description
149 Syntax accent-circumflex
152 \begin_layout Subsection*
156 \begin_layout Description
157 Action Adds a dot accent to the next character typed.
161 \begin_layout Description
165 \begin_layout Subsection*
169 \begin_layout Description
170 Action Adds a grave accent to the next character typed.
174 \begin_layout Description
178 \begin_layout Subsection*
179 LFUN_ACCENT_HUNGARIAN_UMLAUT
182 \begin_layout Description
183 Action Adds a Hungarian umlaut to the next character typed.
187 \begin_layout Description
191 \begin_layout Subsection*
195 \begin_layout Description
196 Action Adds a macron to the next character typed.
200 \begin_layout Description
204 \begin_layout Subsection*
208 \begin_layout Description
209 Action Adds an ogonek accent to the next character typed.
213 \begin_layout Description
217 \begin_layout Subsection*
221 \begin_layout Description
222 Action Adds a tie over the next two character typed.
226 \begin_layout Description
227 Notion The following char will finish the tie.
231 \begin_layout Description
235 \begin_layout Subsection*
239 \begin_layout Description
240 Action Adds a tilde over the next character typed.
244 \begin_layout Description
248 \begin_layout Subsection*
252 \begin_layout Description
253 Action Adds an umlaut over the next character typed.
257 \begin_layout Description
261 \begin_layout Subsection*
265 \begin_layout Description
266 Action Adds a bar under the next character typed.
270 \begin_layout Description
271 Syntax accent-underbar
274 \begin_layout Subsection*
278 \begin_layout Description
279 Action Adds a dot under the next character typed.
283 \begin_layout Description
284 Syntax accent-underdot
287 \begin_layout Subsection*
291 \begin_layout Description
292 Action Inserts a caption inset.
296 \begin_layout Description
297 Syntax caption-insert
300 \begin_layout Description
301 Origin Lgb, 18 Jul 2000
304 \begin_layout Subsection*
308 \begin_layout Description
309 Action Inserts the current date.
313 \begin_layout Description
314 Syntax date-insert [<ARG>]
317 \begin_layout Description
318 Params <ARG>: Format of date.
319 The default value (%x) can be set in Preferences->Date format.
320 For possible formats see manual page of strftime function.
324 \begin_layout Description
325 Origin jdblair, 31 Jan 2000
328 \begin_layout Subsection*
332 \begin_layout Description
333 Action Inserts a footnote inset.
337 \begin_layout Description
338 Syntax footnote-insert
341 \begin_layout Description
342 Origin Jug, 7 Mar 2000
345 \begin_layout Subsection*
349 \begin_layout Description
350 Action Inserts an ERT inset.
354 \begin_layout Description
358 \begin_layout Description
359 Origin Jug, 18 Feb 2000
362 \begin_layout Subsection*
366 \begin_layout Description
367 Action Inserts a float inset.
371 \begin_layout Description
372 Syntax float-insert <TYPE>
375 \begin_layout Description
376 Params <TYPE>: type of float depends on the used textclass.
377 Usually "algorithm", "table", "figure" parameters can be given.
381 \begin_layout Description
382 Origin Lgb, 27 Jun 2000
385 \begin_layout Subsection*
386 LFUN_FLOAT_WIDE_INSERT
389 \begin_layout Description
390 Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
394 \begin_layout Description
395 Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
399 \begin_layout Description
400 Syntax float-wide-insert <TYPE>
403 \begin_layout Description
404 Params <TYPE>: type of float depends on the used textclass.
405 Usually "algorithm", "table", "figure" parameters can be given.
409 \begin_layout Description
410 Origin Lgb, 31 Oct 2001
413 \begin_layout Subsection*
414 LFUN_FLOAT_LIST_INSERT
417 \begin_layout Description
418 Action Inserts the list of floats in the document.
422 \begin_layout Description
423 Syntax float-list-insert <TYPE>
426 \begin_layout Description
427 Params <TYPE>: type of float depends on the used textclass.
428 Usually "algorithm", "table", "figure" parameters can be given.
432 \begin_layout Description
433 Origin Lgb, 3 May 2001
436 \begin_layout Subsection*
440 \begin_layout Description
441 Action Inserts floats wrapped by the text around.
445 \begin_layout Description
446 Syntax wrap-insert <TYPE>
449 \begin_layout Description
450 Params <TYPE>: table|figure
453 \begin_layout Description
454 Origin Dekel, 7 Apr 2002
457 \begin_layout Subsection*
461 \begin_layout Description
462 Action Inserts an optional-argument (short title) inset.
466 \begin_layout Description
467 Syntax optional-insert
470 \begin_layout Description
471 Origin vermeer, 12 Aug 2002
474 \begin_layout Subsection*
478 \begin_layout Description
479 Action Inserts a horizontal line.
483 \begin_layout Description
487 \begin_layout Description
488 Origin Andre, Oct 27 2003
491 \begin_layout Subsection*
495 \begin_layout Description
496 Action Inserts a new page.
500 \begin_layout Description
501 Syntax newpage-insert <ARG>
504 \begin_layout Description
505 Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
509 \begin_layout Description
510 Origin uwestoehr, 24 Nov 2007
513 \begin_layout Subsection*
514 LFUN_MARGINALNOTE_INSERT
517 \begin_layout Description
518 Action Inserts a marginal note.
522 \begin_layout Description
523 Syntax marginalnote-insert
526 \begin_layout Description
527 Origin Lgb, 26 Jun 2000
530 \begin_layout Subsection*
534 \begin_layout Description
535 Action Inserts a single unicode character.
539 \begin_layout Description
540 Syntax unicode-insert <CHAR>
543 \begin_layout Description
544 Params <CHAR>: The character to insert, given as its code point, in hexadecimal.
548 \begin_layout Description
549 Sample unicode-insert 0x0100
552 \begin_layout Description
553 Origin Lgb, 22 Oct 2006
556 \begin_layout Subsection*
560 \begin_layout Description
561 Action Inserts a new listings inset.
565 \begin_layout Description
566 Syntax listing-insert
569 \begin_layout Description
570 Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
573 \begin_layout Subsection*
577 \begin_layout Description
578 Action Inserts quotes according to the type and quote-language preference.
582 \begin_layout Description
583 Action Currently English, Swedish, German, Polish, French, Danish quotes
588 \begin_layout Description
589 Syntax quote-insert [<TYPE>]
592 \begin_layout Description
593 Params <TYPE>: 'single' for single quotes, otherwise double quotes will
598 \begin_layout Subsection*
602 \begin_layout Description
603 Action Displays shortcuts, lyxrc, package and textclass availability and
604 menu information in a non-editable boxed InsetText.
608 \begin_layout Description
609 Notion Apart from lfun arguments you can use the following method:
610 \begin_inset Newline newline
614 input the type and argument of this inset, e.g.
615 "menu paste", in the work area.
617 \begin_inset Newline newline
621 select the text and run info-insert lfun.
625 \begin_layout Description
626 Syntax info-insert <TYPE> <ARG>
629 \begin_layout Description
630 Params <TYPE>: shortcut|lyxrc|package|textclass|menu|buffer
631 \begin_inset Newline newline
634 <ARG>: argument for a given type.
635 Look into InsetInfo.h for detailed description.
639 \begin_layout Description
640 Origin bpeng, 7 Oct 2007
643 \begin_layout Subsection*
647 \begin_layout Description
648 Action Inserts branch inset.
652 \begin_layout Description
653 Syntax branch-insert <BRANCH-NAME>
656 \begin_layout Description
657 Origin vermeer, 17 Aug 2003
660 \begin_layout Subsection*
664 \begin_layout Description
665 Action Inserts Box inset.
669 \begin_layout Description
670 Syntax box-insert [<TYPE>]
673 \begin_layout Description
674 Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
676 \begin_inset Newline newline
679 Framed is the default one.
683 \begin_layout Description
684 Origin vermeer, 7 Oct 2003
687 \begin_layout Subsection*
691 \begin_layout Description
692 Action Inserts CharStyle, Custom inset or XML short element.
696 \begin_layout Description
697 Notion Look into the Customization manual for more information about these
700 \begin_inset Newline newline
703 To make this command enabled the layout file for the document class you're
704 using has to load the character styles.
705 There are a few contained in the Logical Markup module.
706 You can also of course create some yourself.
708 \begin_inset Newline newline
711 For dissolving the element see LFUN_INSET_DISSOLVE.
715 \begin_layout Description
716 Syntax flex-insert <TYPE:Name>
719 \begin_layout Description
720 Params TYPE: CharStyle|Custom|Element|Standard
721 \begin_inset Newline newline
724 Identifies whether this is a Character Style, a Custom Inset or an XML
725 Element, and which dynamical sub-menu this flex inset is in on the LyX
727 If Standard (currently unused): none of these.
728 Name: This name must be defined either in your layout file or imported
731 \begin_inset Newline newline
734 InsetLayout <TYPE:Name>
737 \begin_layout Description
738 Sample flex-insert CharStyle:Code
741 \begin_layout Subsection*
745 \begin_layout Description
746 Action Inserts the given string (accordingly to the correct keymap).
750 \begin_layout Description
751 Notion Automatically replace the currently selected text.
752 Depends on lyxrc settings "auto_region_delete".
756 \begin_layout Description
757 Syntax self-insert <STRING>
760 \begin_layout Subsection*
764 \begin_layout Description
765 Action Inserts one of horizontal space insets.
769 \begin_layout Description
770 Syntax space-insert <NAME> [<LEN>]
773 \begin_layout Description
774 Params <NAME>: normal, protected, thin, quad, qquad, enspace, enskip, negthinspa
775 ce, hfill, hfill*, dotfill, hrulefill, hspace, hspace*
776 \begin_inset Newline newline
779 <LEN>: length for custom spaces (hspace, hspace* for protected)
782 \begin_layout Description
783 Origin JSpitzm, 20 May 2003, Mar 17 2008
786 \begin_layout Subsection*
787 LFUN_HYPERLINK_INSERT
790 \begin_layout Description
791 Action Inserts hyperlinks into the document (clickable in pdf output).
795 \begin_layout Description
796 Notion Hyperlink target can be set via selection + hyperlink-insert function.
800 \begin_layout Description
801 Syntax href-insert [<TARGET>]
804 \begin_layout Description
805 Origin CFO-G, 21 Nov 1997
808 \begin_layout Subsection*
809 LFUN_SPECIALCHAR_INSERT
812 \begin_layout Description
813 Action Inserts various characters into the document.
817 \begin_layout Description
818 Syntax specialchar-insert <CHAR>
821 \begin_layout Description
822 Params <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots, end-of-sen
823 tence, menu-separator.
827 \begin_layout Description
828 Origin JSpitzm, 6 Dec 2007
831 \begin_layout Subsection*
835 \begin_layout Description
836 Action Inserts table of contents.
840 \begin_layout Description
844 \begin_layout Description
845 Origin Lgb, 27 May 97
848 \begin_layout Subsection*
852 \begin_layout Description
853 Action Start (or remove) Appendix on the given cursor position.
857 \begin_layout Description
861 \begin_layout Description
862 Origin ettrich, 5 May 1998
865 \begin_layout Subsection*
869 \begin_layout Description
870 Action Inserts Index entry.
874 \begin_layout Description
875 Notion It automatically takes the word on the cursor position.
879 \begin_layout Description
883 \begin_layout Description
884 Origin leeming, 3 Aug 2000
887 \begin_layout Subsection*
891 \begin_layout Description
892 Action Inserts list of Index entries on a new page.
896 \begin_layout Description
900 \begin_layout Description
901 Origin Lgb, 27 Feb 1997
904 \begin_layout Subsection*
908 \begin_layout Description
909 Action Inserts Nomenclature entry.
913 \begin_layout Description
914 Notion It automatically takes the word on the cursor position if no symbol
919 \begin_layout Description
920 Syntax nomencl-insert [<SYMBOL>]
923 \begin_layout Description
924 Origin Ugras, 4 Nov 2006
927 \begin_layout Subsection*
928 LFUN_NOMENCLATURE_PRINT
931 \begin_layout Description
932 Action Inserts list of Nomenclature entries.
936 \begin_layout Description
937 Syntax nomenclature-print
940 \begin_layout Description
941 Origin Ugras, 4 Nov 2006
944 \begin_layout Subsection*
948 \begin_layout Description
949 Action Inserts Note on the current cursor postion, move selection inside
954 \begin_layout Description
955 Syntax note-insert [<TYPE>]
958 \begin_layout Description
959 Params <TYPE>: <Note|Greyedout|Comment> default: Note
962 \begin_layout Subsection*
966 \begin_layout Description
967 Action Moves the cursor to the begining of next Note inset.
971 \begin_layout Description
975 \begin_layout Subsection*
979 \begin_layout Description
980 Action Changes all Note insets of a particular type (source) to a different
981 type (target) fot the current document.
985 \begin_layout Description
986 Syntax notes-mutate <SOURCE> <TARGET>
989 \begin_layout Description
990 Params <SOURCE/TARGET>: Note|Comment|Greyedout
993 \begin_layout Description
994 Origin sanda, 18 Jun 2008
997 \begin_layout Subsection*
1001 \begin_layout Description
1002 Action Inserts a line break or new line.
1006 \begin_layout Description
1007 Syntax newline-insert [<ARG>]
1010 \begin_layout Description
1011 Params <ARG>: <newline|linebreak> default: newline
1014 \begin_layout Description
1015 Origin JSpitzm, 25 Mar 2008
1018 \begin_layout Subsection*
1022 \begin_layout Description
1023 Action Clears the selection.
1024 If no text is selected call LFUN_FINISHED_FORWARD.
1028 \begin_layout Description
1032 \begin_layout Description
1033 Origin Lgb, 17 May 2001
1036 \begin_layout Subsection*
1040 \begin_layout Description
1041 Action Moves the cursor one line in downward direction.
1045 \begin_layout Description
1049 \begin_layout Subsection*
1053 \begin_layout Description
1054 Action Moves the cursor one line in upward direction.
1058 \begin_layout Description
1062 \begin_layout Subsection*
1066 \begin_layout Description
1067 Action Moves the cursor one line in downward direction adding the current
1068 position to the selection.
1072 \begin_layout Description
1076 \begin_layout Subsection*
1080 \begin_layout Description
1081 Action Moves the cursor one line in upward direction adding the current
1082 position to the selection.
1086 \begin_layout Description
1090 \begin_layout Subsection*
1094 \begin_layout Description
1095 Action Moves the cursor one page in downward direction.
1099 \begin_layout Description
1103 \begin_layout Subsection*
1107 \begin_layout Description
1108 Action Moves the cursor one page in upward direction.
1112 \begin_layout Description
1116 \begin_layout Subsection*
1117 LFUN_SCREEN_DOWN_SELECT
1120 \begin_layout Description
1121 Action Moves the cursor one screen in downward direction adding the current
1122 position to the selection.
1126 \begin_layout Description
1127 Syntax screen-down-select
1130 \begin_layout Subsection*
1131 LFUN_SCREEN_UP_SELECT
1134 \begin_layout Description
1135 Action Moves the cursor one page in upward direction adding the current
1136 position to the selection.
1140 \begin_layout Description
1141 Syntax screen-up-select
1144 \begin_layout Subsection*
1148 \begin_layout Description
1149 Action Scroll the buffer view.
1153 \begin_layout Description
1154 Notion Only scrolls the screen up or down; does not move the cursor.
1158 \begin_layout Description
1159 Syntax scroll <TYPE> <QUANTITY>
1162 \begin_layout Description
1163 Params <TYPE>: line|page
1164 \begin_inset Newline newline
1167 <QUANTITY>: up|down|<number>
1170 \begin_layout Description
1171 Origin Abdel, Dec 27 2007
1174 \begin_layout Subsection*
1175 LFUN_SCREEN_RECENTER
1178 \begin_layout Description
1179 Action Recenters the screen on the current cursor position.
1183 \begin_layout Description
1184 Syntax screen-recenter
1187 \begin_layout Subsection*
1191 \begin_layout Description
1192 Action Moves the cursor one position logically backwards.
1196 \begin_layout Description
1197 Notion This is not the action which should be bound to the arrow keys, because
1198 backwards may be left or right, depending on the language.
1199 The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions,
1200 which in turn may employ this one.
1204 \begin_layout Description
1205 Syntax char-backward
1208 \begin_layout Subsection*
1209 LFUN_CHAR_BACKWARD_SELECT
1212 \begin_layout Description
1213 Action Moves the cursor one position logically backwards, adding traversed
1214 position to the selection.
1218 \begin_layout Description
1219 Notion See also LFUN_CHAR_BACKWARD.
1223 \begin_layout Description
1224 Syntax char-backward-select
1227 \begin_layout Subsection*
1228 LFUN_CHAR_DELETE_BACKWARD
1231 \begin_layout Description
1232 Action Deletes one character in the backward direction (usually the "BackSpace"
1237 \begin_layout Description
1238 Syntax char-delete-backward
1241 \begin_layout Subsection*
1242 LFUN_CHAR_DELETE_FORWARD
1245 \begin_layout Description
1246 Action Deletes one character in the backward direction (usually the "Delete"
1251 \begin_layout Description
1252 Syntax char-delete-forward
1255 \begin_layout Subsection*
1259 \begin_layout Description
1260 Action Moves the cursor one position logically forward.
1264 \begin_layout Description
1265 Notion This is not the action which should be bound to the arrow keys, because
1266 forward may be left or right, depending on the language.
1267 The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions,
1268 which in turn may employ this one.
1272 \begin_layout Description
1276 \begin_layout Subsection*
1277 LFUN_CHAR_FORWARD_SELECT
1280 \begin_layout Description
1281 Action Moves the cursor one position logically forward, adding traversed
1282 position to the selection.
1286 \begin_layout Description
1287 Notion See also LFUN_CHAR_FORWARD.
1291 \begin_layout Description
1292 Syntax char-forward-select
1295 \begin_layout Subsection*
1299 \begin_layout Description
1300 Action Moves the cursor one position "to the left".
1304 \begin_layout Description
1305 Notion This is the action which should be taken when the "left" key is pressed.
1306 Generally, it moves the cursor one position to the left.
1307 However, in Bidi text this become slightly more complicated, and there
1308 are different modes of cursor movement.
1309 In "visual mode", this moves left, plain and simple.
1310 In "logical mode", movement is logically forward in RTL paragraphs, and
1311 logically backwards in LTR paragraphs.
1315 \begin_layout Description
1319 \begin_layout Subsection*
1320 LFUN_CHAR_LEFT_SELECT
1323 \begin_layout Description
1324 Action Moves the cursor one position "to the left", adding traversed position
1329 \begin_layout Description
1330 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1334 \begin_layout Description
1335 Syntax char-left-select
1338 \begin_layout Subsection*
1342 \begin_layout Description
1343 Action Moves the cursor one position "to the right".
1347 \begin_layout Description
1348 Notion This is the action which should be taken when the "right" key is
1350 Generally, it moves the cursor one position to the right.
1351 However, in Bidi text this become slightly more complicated, and there
1352 are different modes of cursor movement.
1353 In "visual mode", this moves right, plain and simple.
1354 In "logical mode", movement is logically forward in LTR paragraphs, and
1355 logically backwards in RTL paragraphs.
1359 \begin_layout Description
1363 \begin_layout Subsection*
1364 LFUN_CHAR_RIGHT_SELECT
1367 \begin_layout Description
1368 Action Moves the cursor one position "to the right", adding traversed position
1373 \begin_layout Description
1374 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1378 \begin_layout Description
1379 Syntax char-right-select
1382 \begin_layout Subsection*
1386 \begin_layout Description
1387 Action Moves the cursor to the logically previous beginning of a word.
1391 \begin_layout Description
1392 Notion This is not the action which should be bound to the arrow keys, because
1393 backwards may be left or right, depending on the language.
1394 The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
1395 which in turn may employ this one.
1399 \begin_layout Description
1400 Syntax word-backward
1403 \begin_layout Subsection*
1404 LFUN_WORD_BACKWARD_SELECT
1407 \begin_layout Description
1408 Action Moves the cursor to the logically previous beginning of a word, adding
1409 the logically traversed text to the selection.
1413 \begin_layout Description
1414 Notion See also LFUN_WORD_BACKWARD.
1418 \begin_layout Description
1419 Syntax word-backward-select
1422 \begin_layout Subsection*
1423 LFUN_WORD_DELETE_BACKWARD
1426 \begin_layout Description
1427 Action Deletes characters to the begining of the word (usually the "C+BackSpace"
1432 \begin_layout Description
1433 Syntax word-delete-backward
1436 \begin_layout Subsection*
1437 LFUN_WORD_DELETE_FORWARD
1440 \begin_layout Description
1441 Action Deletes characters to the end of the word (usually the "C+Delete"
1446 \begin_layout Description
1447 Syntax word-delete-forward
1450 \begin_layout Subsection*
1451 LFUN_WORD_FIND_FORWARD
1454 \begin_layout Description
1455 Action Search for a given string in forward direction.
1459 \begin_layout Description
1460 Notion Case sensitive, match words.
1461 If no argument given, last search repeated.
1465 \begin_layout Description
1466 Syntax word-find-forward [<STRING>]
1469 \begin_layout Description
1470 Origin Etienne, 16 Feb 1998
1473 \begin_layout Subsection*
1474 LFUN_WORD_FIND_BACKWARD
1477 \begin_layout Description
1478 Action Search for a given string in backward direction.
1482 \begin_layout Description
1483 Notion Case sensitive, match words.
1484 If no argument given, last search repeated.
1488 \begin_layout Description
1489 Syntax word-find-backward [<STRING>]
1492 \begin_layout Description
1493 Origin Etienne, 20 Feb 1998
1496 \begin_layout Subsection*
1500 \begin_layout Description
1501 Action Search for next occurence of a string.
1505 \begin_layout Description
1506 Syntax word-find [<DATA>]
1509 \begin_layout Description
1510 Params <DATA>: data encoded from Find dialog (see lyx::find2string()).
1511 If no parameter is given, search with last find-dialog data is used for
1517 \begin_layout Description
1518 Origin Andre, Jan 7 2004
1521 \begin_layout Subsection*
1525 \begin_layout Description
1526 Action Replace a string in the document.
1530 \begin_layout Description
1531 Syntax word-replace [<DATA>]
1534 \begin_layout Description
1535 Params <DATA>: data is of the form "<search>
1536 \begin_inset Newline newline
1540 \begin_inset Newline newline
1543 <casesensitive> <matchword> <all> <forward>"
1546 \begin_layout Description
1547 Origin Andre, Jan 7 2004
1550 \begin_layout Subsection*
1554 \begin_layout Description
1555 Action Moves the cursor to the logically next beginning of a word.
1559 \begin_layout Description
1560 Notion This is not the action which should be bound to the arrow keys, because
1561 forward may be left or right, depending on the language.
1562 The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
1563 which in turn may employ this one.
1567 \begin_layout Description
1571 \begin_layout Subsection*
1572 LFUN_WORD_FORWARD_SELECT
1575 \begin_layout Description
1576 Action Moves the cursor to the logically next beginning of a word, adding
1577 the logically traversed text to the selection.
1581 \begin_layout Description
1582 Notion See also LFUN_WORD_FORWARD.
1586 \begin_layout Description
1587 Syntax word-forward-select
1590 \begin_layout Subsection*
1594 \begin_layout Description
1595 Action Moves the cursor to the next beginning of a word "on the left".
1599 \begin_layout Description
1600 Notion This is the action which should be taken when the (e.g., ctrl-) "left"
1602 Generally, it moves the cursor to the next beginning of a word on the left.
1603 However, in Bidi text this become slightly more complicated, and there
1604 are different modes of cursor movement.
1605 In "visual mode", this moves left, plain and simple.
1606 In "logical mode", movement is logically forward in RTL paragraphs, and
1607 logically backwards in LTR paragraphs.
1611 \begin_layout Description
1615 \begin_layout Description
1616 Origin dov, 28 Oct 2007
1619 \begin_layout Subsection*
1620 LFUN_WORD_LEFT_SELECT
1623 \begin_layout Description
1624 Action Moves the cursor to the next beginning of a word "on the left", adding
1625 *logically* traversed text to the selection.
1629 \begin_layout Description
1630 Notion See also LFUN_WORD_LEFT for exact details of the movement.
1634 \begin_layout Description
1635 Syntax word-left-select
1638 \begin_layout Description
1639 Origin dov, 28 Oct 2007
1642 \begin_layout Subsection*
1646 \begin_layout Description
1647 Action Moves the cursor to the next beginning of a word "on the right".
1651 \begin_layout Description
1652 Notion This is the action which should be taken when the (e.g., ctrl-) "right"
1654 Generally, it moves the cursor to the next beginning of a word on the right.
1655 However, in Bidi text this become slightly more complicated, and there
1656 are different modes of cursor movement.
1657 In "visual mode", this moves right, plain and simple.
1658 In "logical mode", movement is logically forward in LTR paragraphs, and
1659 logically backwards in RTL paragraphs.
1663 \begin_layout Description
1667 \begin_layout Description
1668 Origin dov, 28 Oct 2007
1671 \begin_layout Subsection*
1672 LFUN_WORD_RIGHT_SELECT
1675 \begin_layout Description
1676 Action Moves the cursor to the next beginning of a word "on the right",
1677 adding *logically* traversed text to the selection.
1681 \begin_layout Description
1682 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
1686 \begin_layout Description
1687 Syntax word-right-select
1690 \begin_layout Description
1691 Origin dov, 28 Oct 2007
1694 \begin_layout Subsection*
1698 \begin_layout Description
1699 Action Puts the word where the cursor stands into the selection.
1703 \begin_layout Description
1707 \begin_layout Description
1708 Origin Andre, 11 Sep 2002
1711 \begin_layout Subsection*
1712 LFUN_WORD_CAPITALIZE
1715 \begin_layout Description
1716 Action Capitalizes the words in the selection (i.e.
1717 the first letters) or the letter on the cursor position.
1721 \begin_layout Description
1722 Syntax word-capitalize
1725 \begin_layout Subsection*
1729 \begin_layout Description
1730 Action Change the words in the selection or from the cursor position to
1731 the end of word to the upper case.
1735 \begin_layout Description
1739 \begin_layout Subsection*
1743 \begin_layout Description
1744 Action Change the words in the selection or from the cursor position to
1745 the end of word to the lower case.
1749 \begin_layout Description
1753 \begin_layout Subsection*
1754 LFUN_THESAURUS_ENTRY
1757 \begin_layout Description
1758 Action Look up thesaurus entries with respect to the word under the cursor.
1762 \begin_layout Description
1763 Syntax thesaurus-entry
1766 \begin_layout Description
1767 Origin Levon, 20 Jul 2001
1770 \begin_layout Subsection*
1774 \begin_layout Description
1775 Action Move the cursor to the beginning of the document.
1779 \begin_layout Description
1783 \begin_layout Subsection*
1784 LFUN_BUFFER_BEGIN_SELECT
1787 \begin_layout Description
1788 Action Move the cursor to the beginning of the document adding the traversed
1789 text to the selection.
1793 \begin_layout Description
1794 Syntax buffer-begin-select
1797 \begin_layout Subsection*
1801 \begin_layout Description
1802 Action Move the cursor to the end of the document.
1806 \begin_layout Description
1810 \begin_layout Subsection*
1811 LFUN_BUFFER_END_SELECT
1814 \begin_layout Description
1815 Action Move the cursor to the end of the document adding the traversed text
1820 \begin_layout Description
1821 Syntax buffer-end-select
1824 \begin_layout Subsection*
1828 \begin_layout Description
1829 Action Move the cursor to the begining of the (screen) line.
1833 \begin_layout Description
1837 \begin_layout Subsection*
1838 LFUN_LINE_BEGIN_SELECT
1841 \begin_layout Description
1842 Action Move the cursor to the beginning of the (screen) line adding the
1843 traversed text to the selection.
1847 \begin_layout Description
1848 Syntax line-begin-select
1851 \begin_layout Subsection*
1855 \begin_layout Description
1856 Action Move the cursor to the end of the (screen) line.
1860 \begin_layout Description
1864 \begin_layout Subsection*
1865 LFUN_LINE_END_SELECT
1868 \begin_layout Description
1869 Action Move the cursor to the end of the (screen) line adding the traversed
1870 text to the selection.
1874 \begin_layout Description
1875 Syntax line-end-select
1878 \begin_layout Subsection*
1882 \begin_layout Description
1883 Action Deletes the letters to the end of the (screen) line or deletes the
1888 \begin_layout Description
1889 Syntax line-delete-forward
1892 \begin_layout Subsection*
1896 \begin_layout Description
1897 Action Copies to the clipboard the last edit.
1901 \begin_layout Description
1905 \begin_layout Subsection*
1909 \begin_layout Description
1910 Action Cuts to the clipboard.
1914 \begin_layout Description
1918 \begin_layout Subsection*
1922 \begin_layout Description
1923 Action Pastes material from the active clipboard.
1927 \begin_layout Description
1928 Syntax paste [<TYPE>]
1931 \begin_layout Description
1932 Params <TYPE>: pdf|png|jpeg|linkback
1935 \begin_layout Subsection*
1936 LFUN_CLIPBOARD_PASTE
1939 \begin_layout Description
1940 Action Pastes text from the active clipboard.
1944 \begin_layout Description
1945 Syntax clipboard-paste [<ARG>]
1948 \begin_layout Description
1949 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
1954 \begin_layout Description
1955 Origin baum, 10 Jul 2006
1958 \begin_layout Subsection*
1959 LFUN_PRIMARY_SELECTION_PASTE
1962 \begin_layout Description
1963 Action Pastes the currently text selected text.
1967 \begin_layout Description
1968 Notion Primary selection mechanism is linux-only thing.
1972 \begin_layout Description
1973 Syntax primary-selection-paste [<ARG>]
1976 \begin_layout Description
1977 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
1982 \begin_layout Subsection*
1986 \begin_layout Description
1987 Action Undoes the last edit.
1991 \begin_layout Description
1995 \begin_layout Subsection*
1999 \begin_layout Description
2000 Action Redoes the last thing undone.
2004 \begin_layout Description
2008 \begin_layout Subsection*
2012 \begin_layout Description
2013 Action Repeat the given command.
2017 \begin_layout Description
2018 Syntax repeat <COUNT> <LFUN-COMMAND>
2021 \begin_layout Description
2022 Origin Andre, , 27 Oct 2003
2025 \begin_layout Subsection*
2026 LFUN_CHARS_TRANSPOSE
2029 \begin_layout Description
2030 Action Transposes the character at the cursor with the one before it.
2034 \begin_layout Description
2035 Syntax chars-transpose
2038 \begin_layout Description
2039 Origin Lgb, 25 Apr 2001
2042 \begin_layout Subsection*
2043 LFUN_DEPTH_DECREMENT
2046 \begin_layout Description
2047 Action Decrease the nesting depth of the (selected) paragraph(s) inside
2052 \begin_layout Description
2053 Syntax depth-decrement
2056 \begin_layout Subsection*
2057 LFUN_DEPTH_INCREMENT
2060 \begin_layout Description
2061 Action Increase the nesting depth of the (selected) paragraph(s) inside
2066 \begin_layout Description
2067 Syntax depth-increment
2070 \begin_layout Subsection*
2074 \begin_layout Description
2075 Action Toggles the bold font (selection-wise).
2079 \begin_layout Description
2083 \begin_layout Subsection*
2084 LFUN_FONT_TYPEWRITER
2087 \begin_layout Description
2088 Action Toggles the typewriter family font (selection-wise).
2092 \begin_layout Description
2093 Syntax font-typewriter
2096 \begin_layout Subsection*
2100 \begin_layout Description
2101 Action Toggles underline in the font (selection-wise).
2105 \begin_layout Description
2106 Syntax font-underline
2109 \begin_layout Subsection*
2113 \begin_layout Description
2114 Action Toggles the emphasis font style (selection-wise).
2118 \begin_layout Description
2122 \begin_layout Subsection*
2126 \begin_layout Description
2127 Action Toggles Noun text style font (selection-wise).
2131 \begin_layout Description
2135 \begin_layout Subsection*
2139 \begin_layout Description
2140 Action Toggles Roman family font (selection-wise).
2144 \begin_layout Description
2148 \begin_layout Subsection*
2152 \begin_layout Description
2153 Action Toggles Sans Serif family font (selection-wise).
2157 \begin_layout Description
2161 \begin_layout Subsection*
2165 \begin_layout Description
2166 Action Toggles Fraktur family font (math-mode, selection-wise).
2170 \begin_layout Description
2174 \begin_layout Description
2175 Origin vermeer, 10 Jan 2002
2178 \begin_layout Subsection*
2182 \begin_layout Description
2183 Action Toggles Italics font shape (math-mode, selection-wise).
2187 \begin_layout Description
2191 \begin_layout Description
2192 Origin vermeer, 10 Jan 2002
2195 \begin_layout Subsection*
2199 \begin_layout Description
2200 Action Reverts the settings of the font to the default values (selection-wise).
2204 \begin_layout Description
2208 \begin_layout Subsection*
2212 \begin_layout Description
2213 Action Sets font size according to lyx format string.
2217 \begin_layout Description
2218 Syntax font-size <SIZE>
2221 \begin_layout Description
2222 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
2223 \begin_inset Newline newline
2226 largest|huge|giant|increase|decrease|default
2229 \begin_layout Subsection*
2230 LFUN_TEXTSTYLE_APPLY
2233 \begin_layout Description
2234 Action Toggle user-defined (=last-time used) text style.
2238 \begin_layout Description
2239 Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically
2240 trigerred when using Text Style dialog.
2244 \begin_layout Description
2245 Syntax textstyle-apply
2248 \begin_layout Description
2249 Origin leeming, 12 Mar 2003
2252 \begin_layout Subsection*
2253 LFUN_TEXTSTYLE_UPDATE
2256 \begin_layout Description
2257 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APP
2262 \begin_layout Description
2263 Syntax textstyle-update <FONT_INFO>
2266 \begin_layout Description
2267 Params <FONT_INFO>: specifies font atributes, e.g.
2268 family, series, shape, size, emph, noun, underbar, number, color, language,
2271 \begin_inset Newline newline
2274 Use lyx -dbg action for exact syntax of text-style dialog parameters.
2278 \begin_layout Description
2279 Origin leeming, 12 Mar 2003
2282 \begin_layout Subsection*
2283 LFUN_SCREEN_FONT_UPDATE
2286 \begin_layout Description
2287 Action Update fonts and its metrics.
2291 \begin_layout Description
2292 Notion Automatically called after zoom, dpi, font names, or norm change.
2296 \begin_layout Description
2297 Syntax screen-font-update
2300 \begin_layout Description
2301 Origin ARRae, 13 Aug 2000
2304 \begin_layout Subsection*
2308 \begin_layout Description
2309 Action Returns the info about the current font.
2313 \begin_layout Description
2317 \begin_layout Subsection*
2318 LFUN_CITATION_INSERT
2321 \begin_layout Description
2322 Action Inserts citation from loaded citation database.
2326 \begin_layout Description
2327 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
2330 \begin_layout Description
2331 Params <KEY>: Citation (shortcut listed in available citations).
2333 \begin_inset Newline newline
2336 <TEXT_BEFORE>: text which should appear before citation.
2340 \begin_layout Description
2341 Origin AAS, 97-02-23
2344 \begin_layout Subsection*
2345 LFUN_BIBTEX_DATABASE_ADD
2348 \begin_layout Description
2349 Action Adds database, which will be used for bibtex citations.
2353 \begin_layout Description
2354 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX
2355 bibliography) found from the cursor postion.
2359 \begin_layout Description
2360 Syntax bibtex-database-add <DATABASE-NAME>
2363 \begin_layout Description
2364 Origin Ale, 30 May 1997
2367 \begin_layout Subsection*
2368 LFUN_BIBTEX_DATABASE_DEL
2371 \begin_layout Description
2372 Action Adds database, which will be used for bibtex citations.
2376 \begin_layout Description
2377 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTe
2378 X bibliography) found from the cursor postion.
2382 \begin_layout Description
2383 Syntax bibtex-database-del <DATABASE-NAME>
2386 \begin_layout Description
2387 Origin Ale, 30 May 1997
2390 \begin_layout Subsection*
2394 \begin_layout Description
2395 Action Sets the layout (that is, environment) for the current paragraph.
2399 \begin_layout Description
2400 Syntax layout <LAYOUT>
2403 \begin_layout Description
2404 Params <LAYOUT>: the layout to use
2407 \begin_layout Subsection*
2408 LFUN_LAYOUT_PARAGRAPH
2411 \begin_layout Description
2412 Action Launches the paragraph settings dialog.
2416 \begin_layout Description
2417 Syntax layout-paragraph
2420 \begin_layout Subsection*
2424 \begin_layout Description
2425 Action Launches the tabular settings dialog.
2429 \begin_layout Description
2430 Syntax layout-tabular
2433 \begin_layout Description
2434 Origin Jug, 31 Jul 2000
2437 \begin_layout Subsection*
2438 LFUN_DROP_LAYOUTS_CHOICE
2441 \begin_layout Description
2442 Action Displays list of layout choices.
2446 \begin_layout Description
2447 Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox
2448 allowing for choice of layout.
2452 \begin_layout Description
2453 Syntax drop-layouts-choice
2456 \begin_layout Subsection*
2457 LFUN_LAYOUT_MODULES_CLEAR
2460 \begin_layout Description
2461 Action Clears the module list.
2465 \begin_layout Description
2466 Notion Clears the list of included modules for the current buffer.
2470 \begin_layout Description
2471 Syntax layout-modules-clear
2474 \begin_layout Description
2475 Origin rgh, 25 August 2007
2478 \begin_layout Subsection*
2479 LFUN_LAYOUT_MODULE_ADD
2482 \begin_layout Description
2483 Action Adds a module.
2487 \begin_layout Description
2488 Notion Adds a module to the list of included modules for the current buffer.
2492 \begin_layout Description
2493 Syntax layout-module-add <MODULE>
2496 \begin_layout Description
2497 Params <MODULE>: the module to be added
2500 \begin_layout Description
2501 Origin rgh, 25 August 2007
2504 \begin_layout Subsection*
2508 \begin_layout Description
2509 Action Reloads layout information.
2513 \begin_layout Description
2514 Notion Reloads all layout information for the current buffer from disk,
2515 thus recognizing any changes that have been made to layout files on the
2517 This is intended to be used only by layout developers and should not be
2518 used when one is trying to do actual work.
2522 \begin_layout Description
2523 Syntax layout-reload
2526 \begin_layout Description
2527 Origin rgh, 3 September 2007
2530 \begin_layout Subsection*
2531 LFUN_TEXTCLASS_APPLY
2534 \begin_layout Description
2535 Action Sets the text class for the current buffer.
2539 \begin_layout Description
2540 Syntax textclass-apply <TEXTCLASS>
2543 \begin_layout Description
2544 Params <TEXTCLASS>: the textclass to set.
2545 Note that this must be the filename, minus the ".layout" extension.
2549 \begin_layout Subsection*
2553 \begin_layout Description
2554 Action Loads information for a textclass from disk.
2558 \begin_layout Description
2559 Syntax textclass-load <TEXTCLASS>
2562 \begin_layout Description
2563 Params <TEXTCLASS>: the textclass to load.
2564 Note that this must be the filename, minus the ".layout" extension.
2568 \begin_layout Subsection*
2572 \begin_layout Description
2573 Action Disable selecting of text-region.
2577 \begin_layout Description
2581 \begin_layout Subsection*
2585 \begin_layout Description
2586 Action Enable selecting of text-region.
2590 \begin_layout Description
2591 Notion After enabling you can simply move arrow keys to get selected region.
2595 \begin_layout Description
2599 \begin_layout Subsection*
2603 \begin_layout Description
2604 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
2608 \begin_layout Description
2612 \begin_layout Description
2613 Origin Andre, May 5 2006
2616 \begin_layout Subsection*
2620 \begin_layout Description
2621 Action Inserts math delimiters (e.g.
2622 parentheses, brackets) enclosing expression.
2626 \begin_layout Description
2627 Syntax math-delim [<LEFT>] [<RIGHT>]
2630 \begin_layout Description
2631 Params <LEFT/RIGHT>: Delimiters to be used.
2632 Each delimiter can be specified by either a LaTeX name or a valid character.
2633 ( is the default letter.
2637 \begin_layout Description
2638 Sample math-delim { rangle
2641 \begin_layout Description
2642 Origin Alejandro, 18 Jun 1996
2645 \begin_layout Subsection*
2649 \begin_layout Description
2650 Action Inserts math fixed size delimiters (e.g.
2651 parentheses, brackets) enclosing expression.
2655 \begin_layout Description
2656 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
2659 \begin_layout Description
2660 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
2661 \begin_inset Newline newline
2664 <L/RDELIM>: TeX code for delimiter.
2665 See Delimiter dialog for delimiters to be used.
2669 \begin_layout Description
2670 Sample math-bigdelim "Bigl" "Downarrow" "Bigr" "}"
2673 \begin_layout Description
2674 Origin Enrico & Georg, 7 May 2006
2677 \begin_layout Subsection*
2681 \begin_layout Description
2682 Action Creates a new displayed equation in text mode.
2683 Toggles inlined/display formula in math mode.
2687 \begin_layout Description
2688 Syntax math-display [<ARG>]
2691 \begin_layout Description
2692 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating
2693 new equation from the text mode.
2697 \begin_layout Description
2698 Origin Alejandro, 18 Jun 1996
2701 \begin_layout Subsection*
2705 \begin_layout Description
2706 Action Inserts math objects and symbols.
2710 \begin_layout Description
2711 Syntax math-insert <ARG>
2714 \begin_layout Description
2715 Params <ARG>: Symbol or LaTeX code to be inserted.
2719 \begin_layout Subsection*
2723 \begin_layout Description
2724 Action Enters subscript expression in math expression.
2728 \begin_layout Description
2729 Syntax math-subscript
2732 \begin_layout Description
2733 Origin vermeer, 12 Dec 2001
2736 \begin_layout Subsection*
2737 LFUN_MATH_SUPERSCRIPT
2740 \begin_layout Description
2741 Action Enters subscript expression in math expression.
2745 \begin_layout Description
2746 Syntax math-superscript
2749 \begin_layout Description
2750 Origin vermeer, 12 Dec 2001
2753 \begin_layout Subsection*
2757 \begin_layout Description
2758 Action Toggles the position of the limits from above/below to the right
2759 side an vice versa in integral symbol, a limit, a summation, etc.
2763 \begin_layout Description
2764 Notion Put the cursor before the symbol with the limits and then invoke
2769 \begin_layout Description
2770 Syntax math-limits [<STATE>]
2773 \begin_layout Description
2774 Params <STATE>: limits|nolimits
2777 \begin_layout Subsection*
2781 \begin_layout Description
2782 Action Inserts a math macro definition at the cursor position in the text.
2786 \begin_layout Description
2787 Syntax math-macro <NAME> [<NARGS>] [def]
2790 \begin_layout Description
2791 Params <NAME>: The name of the macro, e.g.
2793 <NARGS>: The number of parameters of the macro.
2795 "def": Has no effect anymore, just for compatibility with former LyX versions.
2799 \begin_layout Description
2800 Origin ale, 10 May 1997; sts, 21 Dec 2007
2803 \begin_layout Subsection*
2807 \begin_layout Description
2808 Action Mutates the type of math inset to the newly selected one.
2812 \begin_layout Description
2813 Syntax math-mutate <TYPE>
2816 \begin_layout Description
2817 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
2818 multline|gather|flalign
2821 \begin_layout Description
2822 Origin Andre, 23 May 2001
2825 \begin_layout Subsection*
2829 \begin_layout Description
2830 Action Inserts space into math expression.
2834 \begin_layout Description
2835 Notion Use spacebar after entering this space to change type of space.
2839 \begin_layout Description
2840 Syntax math-space [<TYPE>]
2843 \begin_layout Description
2844 Params <TYPE>: negative spaces: !|negmedspace|negthickspace
2845 \begin_inset Newline newline
2848 positive spaces: ,|:|;|quad|qquad
2849 \begin_inset Newline newline
2852 "," used by default.
2856 \begin_layout Description
2857 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
2860 \begin_layout Subsection*
2864 \begin_layout Description
2865 Action Inserts a matrix.
2869 \begin_layout Description
2870 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
2873 \begin_layout Description
2874 Params <ALIGN>: Alignment is a word composed of the vertical alignment (b,
2876 1 char) and the horizontal alignments (l, c or r) (i.e.
2881 \begin_layout Description
2882 Sample math-matrix 3 3 bccc
2885 \begin_layout Subsection*
2889 \begin_layout Description
2890 Action In text mode enters math mode (i.e.
2891 puts math insets on the current cursor position), in math mode enters text
2892 mode inside math expression.
2896 \begin_layout Description
2897 Notion If there is some selected text, it puts the text inside created math
2902 \begin_layout Description
2903 Syntax math-mode [<ARG>]
2906 \begin_layout Description
2907 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT
2912 \begin_layout Description
2913 Origin Alejandro, 4 Jun 1996
2916 \begin_layout Subsection*
2917 LFUN_MATH_NUMBER_LINE_TOGGLE
2920 \begin_layout Description
2921 Action Toggles numbering of the current formula line.
2925 \begin_layout Description
2926 Notion Must be in display formula mode.
2930 \begin_layout Description
2931 Syntax math-number-line-toggle
2934 \begin_layout Description
2935 Origin Alejandro, 18 Jun 1996
2938 \begin_layout Subsection*
2939 LFUN_MATH_NUMBER_TOGGLE
2942 \begin_layout Description
2943 Action Toggles numbering/labeling of the current formula.
2947 \begin_layout Description
2948 Notion Must be in display formula mode.
2952 \begin_layout Description
2953 Syntax math-number-toggle
2956 \begin_layout Description
2957 Origin Alejandro, 4 Jun 1996
2960 \begin_layout Subsection*
2964 \begin_layout Description
2965 Action Calls external program and passes the current expression/equation
2966 as an argument for the calculation in the format appropriate to the given
2971 \begin_layout Description
2972 Notion Selection can be used to determine the input for the external program.
2976 \begin_layout Description
2977 Syntax math-extern <LANG> [<COMMAND>]
2980 \begin_layout Description
2981 Params <LANG>: octave|maxima|maple|mathematica|script
2982 \begin_inset Newline newline
2985 where "script" stands fot the external script (normalized expression will
2989 \begin_layout Description
2990 Origin Andre, 24 Apr 2001
2993 \begin_layout Description
2994 Sample math-extern maple simplify
2997 \begin_layout Subsection*
3001 \begin_layout Description
3002 Action Changes arbitrarily the size used by math fonts inside a context.
3006 \begin_layout Description
3007 Notion Provides an interface to the LaTeX math mode font size commands.
3011 \begin_layout Description
3012 Syntax math-size <STYLE>
3015 \begin_layout Description
3016 Params <STYLE>: displaystyle|
3025 \begin_layout Description
3026 Origin Alejandro, 15 Aug 1996; ps, 14 Jun 2008
3029 \begin_layout Subsection*
3030 LFUN_MATH_MACRO_UNFOLD
3033 \begin_layout Description
3034 Action Unfold a Math Macro.
3038 \begin_layout Description
3039 Notion Unfold the Math Macro the cursor is in, i.e.
3044 \begin_layout Description
3045 Syntax math-macro-unfold
3048 \begin_layout Description
3049 Origin sts, 06 January 2008
3052 \begin_layout Subsection*
3053 LFUN_MATH_MACRO_FOLD
3056 \begin_layout Description
3057 Action Fold a Math Macro.
3061 \begin_layout Description
3062 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e.
3063 displayed as foo before.
3067 \begin_layout Description
3068 Syntax math-macro-fold
3071 \begin_layout Description
3072 Origin sts, 06 January 2008
3075 \begin_layout Subsection*
3076 LFUN_MATH_MACRO_ADD_PARAM
3079 \begin_layout Description
3080 Action Add a parameter.
3084 \begin_layout Description
3085 Notion Add a parameter to a Math Macro.
3089 \begin_layout Description
3090 Params <NUM>: The number of the parameter behind which the new one will
3091 be added (1 for the first, i.e.
3092 use 0 for add a parameter at the left), defaults to the last one.
3096 \begin_layout Description
3097 Syntax math-macro-add-param <NUM>
3100 \begin_layout Description
3101 Origin sts, 06 January 2008
3104 \begin_layout Subsection*
3105 LFUN_MATH_MACRO_REMOVE_PARAM
3108 \begin_layout Description
3109 Action Remove the last parameter.
3113 \begin_layout Description
3114 Notion Remove the last parameter of a Math Macro and remove its value in
3115 all instances of the macro in the buffer.
3119 \begin_layout Description
3120 Params <NUM>: The number of the parameter to be deleted (1 for the first),
3121 defaults to the last one.
3125 \begin_layout Description
3126 Syntax math-macro-remove-param <NUM>
3129 \begin_layout Description
3130 Origin sts, 06 January 2008
3133 \begin_layout Subsection*
3134 LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
3137 \begin_layout Description
3138 Action Append a greedy parameter.
3142 \begin_layout Description
3143 Notion Append a greedy parameter to a Math Macro which eats the following
3144 mathed cell in every instance of the macro in the buffer.
3148 \begin_layout Description
3149 Syntax math-macro-append-greedy-param
3152 \begin_layout Description
3153 Origin sts, 06 January 2008
3156 \begin_layout Subsection*
3157 LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
3160 \begin_layout Description
3161 Action Remove a greedy parameter.
3165 \begin_layout Description
3166 Notion Remove a greedy parameter of a Math Macro and spit out the values
3167 of it in every instance of the macro in the buffer.
3168 If it is an optional parameter the [valud] format is used.
3172 \begin_layout Description
3173 Syntax math-macro-remove-greedy-param
3176 \begin_layout Description
3177 Origin sts, 06 January 2008
3180 \begin_layout Subsection*
3181 LFUN_MATH_MACRO_MAKE_OPTIONAL
3184 \begin_layout Description
3185 Action Make a parameter optional.
3189 \begin_layout Description
3190 Notion Turn the first non-optional parameter of a Math Macro into an optional
3191 parameter with a default value.
3195 \begin_layout Description
3196 Syntax math-macro-make-optional
3199 \begin_layout Description
3200 Origin sts, 06 January 2008
3203 \begin_layout Subsection*
3204 LFUN_MATH_MACRO_MAKE_NONOPTIONAL
3207 \begin_layout Description
3208 Action Make a parameter non-optional.
3212 \begin_layout Description
3213 Notion Turn the last optional parameter of a Math Macro into a non-optional
3215 The default value is remembered to be reused later if the user changes
3220 \begin_layout Description
3221 Syntax math-macro-make-nonoptional
3224 \begin_layout Description
3225 Origin sts, 06 January 2008
3228 \begin_layout Subsection*
3229 LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
3232 \begin_layout Description
3233 Action Add an optional parameter.
3237 \begin_layout Description
3238 Notion Insert an optional parameter just behind the already existing optional
3243 \begin_layout Description
3244 Syntax math-macro-add-optional-param
3247 \begin_layout Description
3248 Origin sts, 06 January 2008
3251 \begin_layout Subsection*
3252 LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
3255 \begin_layout Description
3256 Action Remove the last optional parameter.
3260 \begin_layout Description
3261 Notion Remove the last optional parameter of a Math Macro and remove it
3262 in all the instances of the macro in the buffer.
3266 \begin_layout Description
3267 Syntax math-macro-remove-optional-param
3270 \begin_layout Description
3271 Origin sts, 06 January 2008
3274 \begin_layout Subsection*
3275 LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
3278 \begin_layout Description
3279 Action Add a greedy optional parameter.
3283 \begin_layout Description
3284 Notion Add a greedy optional parameter which eats the value from the following
3285 cells in mathed which are in the [value] format.
3289 \begin_layout Description
3290 Syntax math-macro-add-greedy-optional-param
3293 \begin_layout Description
3294 Origin sts, 06 January 2008
3297 \begin_layout Subsection*
3298 LFUN_IN_MATHMACROTEMPLATE
3301 \begin_layout Description
3302 Action Only active in Math Macro definition.
3306 \begin_layout Description
3307 Notion Dummy function which is only active in a Math Macro definition.
3308 It's used to toggle the Math Macro toolbar if the cursor moves into a Math
3313 \begin_layout Description
3314 Syntax in-mathmacrotemplate
3317 \begin_layout Description
3318 Origin sts, 06 January 2008
3321 \begin_layout Subsection*
3322 LFUN_PARAGRAPH_MOVE_DOWN
3325 \begin_layout Description
3326 Action Moves the current paragraph downwards in the document.
3330 \begin_layout Description
3331 Syntax paragraph-move-down
3334 \begin_layout Description
3335 Origin Edwin, 8 Apr 2006
3338 \begin_layout Subsection*
3339 LFUN_PARAGRAPH_MOVE_UP
3342 \begin_layout Description
3343 Action Moves the current paragraph upwards in the document.
3347 \begin_layout Description
3348 Syntax paragraph-move-up
3351 \begin_layout Description
3352 Origin Edwin, 8 Apr 2006
3355 \begin_layout Subsection*
3359 \begin_layout Description
3360 Action Move the cursor to the next paragraph (or begining of the current
3361 one) in upward direction.
3365 \begin_layout Description
3369 \begin_layout Description
3370 Origin Asger, 1 Oct 1996
3373 \begin_layout Subsection*
3374 LFUN_PARAGRAPH_UP_SELECT
3377 \begin_layout Description
3378 Action Move the cursor and select the text to the next paragraph (or begining
3379 of the current one) in upward direction.
3383 \begin_layout Description
3384 Syntax paragraph-up-select
3387 \begin_layout Description
3388 Origin Asger, 1 Oct 1996
3391 \begin_layout Subsection*
3395 \begin_layout Description
3396 Action Move the cursor to the next paragraph (or begining of the current
3397 one) in downward direction.
3401 \begin_layout Description
3402 Syntax paragraph-down
3405 \begin_layout Description
3406 Origin Asger, 1 Oct 1996
3409 \begin_layout Subsection*
3410 LFUN_PARAGRAPH_DOWN_SELECT
3413 \begin_layout Description
3414 Action Move the cursor and select the text to the next paragraph (or begining
3415 of the current one) in downward direction.
3419 \begin_layout Description
3420 Syntax paragraph-down-select
3423 \begin_layout Description
3424 Origin Asger, 1 Oct 1996
3427 \begin_layout Subsection*
3431 \begin_layout Description
3432 Action Jump to a paragraph given by its id number and optionally the desired
3433 position within the paragraph.
3437 \begin_layout Description
3438 Notion Note that id number of paragraph is not the sequential number of
3439 paragraph seen on the screen.
3440 Moreover the id is unique for all opened buffers (documents).
3444 \begin_layout Description
3445 Syntax paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
3448 \begin_layout Description
3449 Params <PAR_ID_NUMBER>: paragraph id
3450 \begin_inset Newline newline
3453 <POSITION_IN_PAR>: desired position within the paragraph
3456 \begin_layout Description
3457 Origin Dekel, 26 Aug 2000
3460 \begin_layout Subsection*
3461 LFUN_BREAK_PARAGRAPH
3464 \begin_layout Description
3465 Action Breaks the current paragraph at the current location.
3469 \begin_layout Description
3470 Syntax break-paragraph
3473 \begin_layout Subsection*
3474 LFUN_BREAK_PARAGRAPH
3477 \begin_layout Description
3478 Action Breaks the current paragraph at the current location.
3482 \begin_layout Description
3483 Notion Removes the selection.
3487 \begin_layout Description
3488 Syntax break-paragraph [<LAYOUT>]
3491 \begin_layout Description
3492 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to
3493 default layout) when the cursor is at the end of the line.
3497 \begin_layout Subsection*
3498 LFUN_PARAGRAPH_PARAMS
3501 \begin_layout Description
3502 Action Change paragraph settings.
3506 \begin_layout Description
3507 Notion Modifies the current paragraph, or currently selected paragraphs.
3508 This function only modifies, and does not override, existing settings.
3509 Note that the "leftindent" indent setting is deprecated.
3513 \begin_layout Description
3514 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
3517 \begin_layout Description
3527 \begin_inset Newline newline
3532 paragraph_spacing default|single|onehalf|double|other
3533 \begin_inset Newline newline
3538 align block|left|right|center|default
3539 \begin_inset Newline newline
3544 labelwidthstring WIDTH|
3547 \begin_inset Newline newline
3553 \begin_layout Description
3554 Origin rgh, Aug 15 2007
3557 \begin_layout Subsection*
3558 LFUN_PARAGRAPH_PARAMS_APPLY
3561 \begin_layout Description
3562 Action Change paragraph settings.
3566 \begin_layout Description
3567 Notion Overwrite all nonspecified settings to the default ones.
3568 Use paragraph-params lfun if you don't want to overwrite others settings.
3572 \begin_layout Description
3573 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
3576 \begin_layout Description
3577 Params For parameters see LFUN_PARAGRAPH_PARAMS
3580 \begin_layout Description
3581 Origin leeming, 30 Mar 2004
3584 \begin_layout Subsection*
3585 LFUN_PARAGRAPH_UPDATE
3588 \begin_layout Description
3589 Action Updates the values inside the paragraph dialog from the paragraph.
3593 \begin_layout Description
3594 Notion This is internal LFUN, not to be used by users.
3595 Called internally by LFUN_DIALOG_UPDATE.
3599 \begin_layout Description
3600 Origin leeming, 13 Mar 2003
3603 \begin_layout Subsection*
3607 \begin_layout Description
3608 Action Move the current group in the upward direction in the structure of
3613 \begin_layout Description
3614 Notion The "group" can be Part/Chapter/Section/etc.
3615 It moves the whole substructure of the group.
3619 \begin_layout Description
3623 \begin_layout Description
3624 Origin Vermeer, 23 Mar 2006
3627 \begin_layout Subsection*
3631 \begin_layout Description
3632 Action Move the current group in the downward direction in the structure
3637 \begin_layout Description
3638 Notion The "group" can be Part/Chapter/Section/etc.
3639 It moves the whole substructure of the group.
3643 \begin_layout Description
3647 \begin_layout Description
3648 Origin Vermeer, 23 Mar 2006
3651 \begin_layout Subsection*
3655 \begin_layout Description
3656 Action Moves the current group in the downward direction in the hierarchy
3657 of the document structure.
3661 \begin_layout Description
3662 Notion Part -> Chapter -> Section -> etc.
3666 \begin_layout Description
3670 \begin_layout Description
3671 Origin Vermeer, 23 Mar 2006
3674 \begin_layout Subsection*
3678 \begin_layout Description
3679 Action Moves the current group in the upward direction in the hierarchy
3680 of the document structure.
3684 \begin_layout Description
3685 Notion Part <- Chapter <- Section <- etc.
3689 \begin_layout Description
3693 \begin_layout Description
3694 Origin Vermeer, 23 Mar 2006
3697 \begin_layout Subsection*
3701 \begin_layout Description
3702 Action Edit the inset at cursor with an external application, *
3703 if one is attributed.
3707 \begin_layout Description
3708 Syntax inset-edit [<INSET_PARAMS>]
3711 \begin_layout Description
3712 Params <INSET_PARAMS>: Parameters for the inset.
3714 \begin_inset Newline newline
3717 Currently only the filename will be considered.
3721 \begin_layout Description
3722 Origin JSpitzm, 27 Apr 2006
3725 \begin_layout Subsection*
3729 \begin_layout Description
3730 Action Inserts table into the document.
3734 \begin_layout Description
3735 Syntax tabular-insert [<ROWS> <COLUMNS>]
3738 \begin_layout Description
3739 Params In case no arguments are given show insert dialog.
3743 \begin_layout Description
3744 Origin Jug, 12 Apr 2000
3747 \begin_layout Subsection*
3748 LFUN_TABULAR_FEATURE
3751 \begin_layout Description
3752 Action Sets various features to the table/cell on the current cursor position.
3756 \begin_layout Description
3757 Notion Various math-environment features are handled here as well, e.g.
3758 add-vline-left/right for Grid/Cases environment
3761 \begin_layout Description
3762 Syntax tabular-feature <FEATURE> [<ARG>]
3765 \begin_layout Description
3766 Params <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|cop
3767 y-column| toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
3768 align-left|align-right|align-center|align-block|valign-top|valign-bottom|
3769 valign-middle|m-align-left|m-align-right|m-align-center|m-valign-top| m-valign-
3770 bottom|m-valign-middle|multicolumn|set-all-lines|unset-all-lines| set-longtabula
3771 r|unset-longtabular|set-pwidth|set-mpwidth| set-rotate-tabular|unset-rotate-tabu
3772 lar|toggle-rotate-tabular| set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|
3773 set-usebox|set-lthead| unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot
3774 |unset-ltfoot| set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
3775 set-special-column|set-special-multi|set-booktabs|unset-booktabs| set-top-space
3776 |set-bottom-space|set-interline-space|set-border-lines
3777 \begin_inset Newline newline
3780 <ARG>: additional argument for some commands, use debug mode to explore
3785 \begin_layout Description
3786 Origin Jug, 28 Jul 2000
3789 \begin_layout Subsection*
3793 \begin_layout Description
3794 Action Moves the cursor to the previous cell inside the table.
3798 \begin_layout Description
3799 Syntax cell-backward
3802 \begin_layout Description
3803 Origin Jug, 22 May 2000
3806 \begin_layout Subsection*
3810 \begin_layout Description
3811 Action Moves the cursor to the next cell inside the table.
3815 \begin_layout Description
3819 \begin_layout Subsection*
3823 \begin_layout Description
3824 Action Splits cell and shifts right part to the next cell (inside the math
3829 \begin_layout Description
3833 \begin_layout Description
3834 Origin Ale, 15 May 1997
3837 \begin_layout Subsection*
3841 \begin_layout Description
3842 Action Register the document as an file inside version control system (RCS,
3847 \begin_layout Description
3848 Notion File is registered inside cvs, svn or rcs repository acording to
3849 the existence of cvs/svn/rcs entries in the document's directory.
3851 \begin_inset Newline newline
3854 See LyX Extended Manual (Version Control Chapter) for additional information.
3858 \begin_layout Description
3862 \begin_layout Description
3863 Origin Lgb, 1 Jul 1997
3866 \begin_layout Subsection*
3870 \begin_layout Description
3871 Action Checks-in/commits the changes of the registered file to the repository.
3875 \begin_layout Description
3876 Notion In RCS case this also unlocks the file.
3880 \begin_layout Description
3884 \begin_layout Description
3885 Origin Lgb, 1 Jul 1997
3888 \begin_layout Subsection*
3892 \begin_layout Description
3893 Action Checks-out the document for edit (and locks it for RCS).
3897 \begin_layout Description
3898 Notion This is implemented only for RCS and SVN, not CVS.
3902 \begin_layout Description
3906 \begin_layout Description
3907 Origin Lgb, 1 Jul 1997
3910 \begin_layout Subsection*
3914 \begin_layout Description
3915 Action Reverts the document to the last check-in/commit in VCS.
3919 \begin_layout Description
3923 \begin_layout Description
3924 Origin Lgb, 1 Jul 1997
3927 \begin_layout Subsection*
3931 \begin_layout Description
3932 Action Undo last check-in.
3936 \begin_layout Description
3937 Notion This is currently implemented only for RCS.
3941 \begin_layout Description
3945 \begin_layout Description
3946 Origin Lgb, 1 Jul 1997
3949 \begin_layout Subsection*
3953 \begin_layout Description
3954 Action Toggles change tracking to on/off.
3958 \begin_layout Description
3959 Syntax changes-track
3962 \begin_layout Description
3963 Origin levon, 1 Oct 2002
3966 \begin_layout Subsection*
3970 \begin_layout Description
3971 Action Toggles showing of change tracking in typesetted output.
3975 \begin_layout Description
3976 Syntax changes-output
3979 \begin_layout Description
3980 Origin jspitzm, 21 Jan 2005
3983 \begin_layout Subsection*
3987 \begin_layout Description
3988 Action Moves the cursor to the position of the next change of the change
3993 \begin_layout Description
3997 \begin_layout Description
3998 Origin schmitt, 4 Oct 2006
4001 \begin_layout Subsection*
4005 \begin_layout Description
4006 Action Open change tracking dialog for merging and moves the cursor to the
4007 position of the next change.
4011 \begin_layout Description
4012 Syntax changes-merge
4015 \begin_layout Description
4016 Origin Levon, 16 Oct 2002
4019 \begin_layout Subsection*
4023 \begin_layout Description
4024 Action Accepts tracked change inside the selection.
4028 \begin_layout Description
4029 Syntax change-accept
4032 \begin_layout Description
4033 Origin Levon, 16 Oct 2002
4036 \begin_layout Subsection*
4040 \begin_layout Description
4041 Action Rejects tracked change inside the selection.
4045 \begin_layout Description
4046 Syntax change-accept
4049 \begin_layout Description
4050 Origin Levon, 16 Oct 2002
4053 \begin_layout Subsection*
4054 LFUN_ALL_CHANGES_ACCEPT
4057 \begin_layout Description
4058 Action Accepts all tracked changes in the document.
4062 \begin_layout Description
4063 Syntax all-changes-accept
4066 \begin_layout Description
4067 Origin Levon, 16 Oct 2002
4070 \begin_layout Subsection*
4071 LFUN_ALL_CHANGES_REJECT
4074 \begin_layout Description
4075 Action Rejects all tracked changes in the document.
4079 \begin_layout Description
4080 Notion Reject does not work recursively; the user may have to repeat the
4085 \begin_layout Description
4086 Syntax all-changes-reject
4089 \begin_layout Description
4090 Origin Levon, 16 Oct 2002
4093 \begin_layout Subsection*
4097 \begin_layout Description
4098 Action Apply data for an inset.
4102 \begin_layout Description
4103 Notion LFUN_INSET_APPLY is sent from the dialogs when the data should be
4105 This is either changed to LFUN_INSET_MODIFY or LFUN_INSET_INSERT depending
4106 on the context where it is called.
4110 \begin_layout Description
4111 Syntax inset-apply <ARGS>
4114 \begin_layout Description
4115 Params See LFUN_INSET_INSERT .
4119 \begin_layout Subsection*
4123 \begin_layout Description
4124 Action Dissolve the current inset into text.
4128 \begin_layout Description
4129 Syntax inset-dissolve [<INSET>]
4132 \begin_layout Description
4133 Params <INSET>: this can be used to make sure the right kind of inset is
4135 For example "dissolve" entry in the charstyles sub-menu should only dissolve
4136 the charstyle inset, even if the cursor is inside several nested insets
4139 \begin_inset Newline newline
4142 For values see lyx::InsetLayout::lyxtype_ .
4146 \begin_layout Description
4147 Origin JSpitz, 7 Aug 2006
4150 \begin_layout Subsection*
4154 \begin_layout Description
4155 Action Insert new inset (type given by the parameters).
4159 \begin_layout Description
4160 Syntax inset-insert <INSET> <ARGS>
4163 \begin_layout Description
4164 Params <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics| hyperlink|i
4165 nclude|index|label|nomencl|vspace|ref|toc>
4166 \begin_inset Newline newline
4169 <ARGS>: depends on the given inset.
4170 Use "lyx -dbg action" to explore.
4174 \begin_layout Description
4175 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
4178 \begin_inset Newline newline
4181 where <label name> is the name of the referenced label and<Format> is one
4183 \begin_inset Newline newline
4187 \begin_inset Newline newline
4190 eqref -- (<reference>)
4191 \begin_inset Newline newline
4195 \begin_inset Newline newline
4198 vpageref -- on <page>
4199 \begin_inset Newline newline
4202 vref -- <reference> on <page>
4203 \begin_inset Newline newline
4206 prettyref -- Formatted reference
4209 \begin_layout Subsection*
4213 \begin_layout Description
4214 Action Modify existing inset.
4218 \begin_layout Description
4219 Notion Used for label, floats, listings, box, branch, external, wrap bibtex,
4220 ert, command, graphics, note, space, vspace, tabular, bibitem, inlude,
4225 \begin_layout Description
4226 Syntax inset-modify <INSET> <ARGS>
4229 \begin_layout Description
4230 Params See LFUN_INSET_INSERT for further details.
4234 \begin_layout Subsection*
4235 LFUN_NEXT_INSET_MODIFY
4238 \begin_layout Description
4239 Action Modify the inset at cursor position, if there is one.
4243 \begin_layout Description
4244 Notion Used for label, floats, listings, box, branch, external, wrap bibtex,
4245 ert, command, graphics, note, space, vspace, tabular, bibitem, inlude,
4250 \begin_layout Description
4251 Syntax next-inset-modify <INSET> <ARGS>
4254 \begin_layout Description
4255 Syntax next-inset-modify changetype <TYPE>
4258 \begin_layout Description
4259 Params See LFUN_INSET_INSERT for further details.
4263 \begin_layout Description
4264 Origin JSpitzm, 23 Mar 2008
4267 \begin_layout Subsection*
4268 LFUN_INSET_DIALOG_UPDATE
4271 \begin_layout Description
4272 Action Updates the values inside the dialog from the inset.
4276 \begin_layout Description
4277 Notion This is internal LFUN, not to be used by users.
4278 Called internally by LFUN_DIALOG_UPDATE
4281 \begin_layout Description
4282 Params <DIALOG-NAME>
4285 \begin_layout Description
4286 Origin leeming, 25 Feb 2003
4289 \begin_layout Subsection*
4293 \begin_layout Description
4294 Action Open the inset's properties dialog.
4298 \begin_layout Description
4299 Notion Used for box, branch, ert, float, listings, note, tabular, wrap insets.
4303 \begin_layout Description
4304 Syntax inset-settings <INSET>
4307 \begin_layout Description
4308 Params <INSET>: <box|branch|ert|float|listings|note|tabular|wrap>
4311 \begin_layout Subsection*
4312 LFUN_NEXT_INSET_TOGGLE
4315 \begin_layout Description
4316 Action Toggles the inset at cursor position.
4317 For collapsables, this means it will be (un-)collapsed, in case of other
4318 insets, the editing widget (dialog) will be entered.
4320 LFUN_INSET_SETTINGS.
4324 \begin_layout Description
4325 Notion Used for label, floats, listings, box, branch, external, wrap bibtex,
4326 ert, command, graphics, note, space, vspace, tabular, bibitem, inlude,
4331 \begin_layout Description
4332 Syntax next-inset-toggle <ARG>
4335 \begin_layout Description
4336 Params <ARG>: these are passed as arguments to LFUN_INSET_TOGGLE .
4340 \begin_layout Description
4341 Origin leeming, 30 Mar 2004
4344 \begin_layout Subsection*
4348 \begin_layout Description
4349 Action Toggles the collapsable inset we are currently in.
4353 \begin_layout Description
4354 Syntax inset-toggle [<ARG>]
4357 \begin_layout Description
4358 Params <ARG>: <open|close|toggle|assign>.
4360 \begin_inset Newline newline
4363 open/close/toggle are for collapsable insets.
4364 close can be currently used by LFUN_NEXT_INSET_TOGGLE.
4365 toggle is used when no argument is given.
4367 \begin_inset Newline newline
4370 assign is for branch inset.
4374 \begin_layout Description
4375 Origin lasgouttes, 19 Jul 2001
4378 \begin_layout Subsection*
4379 LFUN_ALL_INSETS_TOGGLE
4382 \begin_layout Description
4383 Action Toggles (open/closes) all collapsable insets (of a given type) in
4388 \begin_layout Description
4389 Notion Used for box, branch, ert, float, listings, note, tabular, wrap insets.
4393 \begin_layout Description
4394 Syntax all-insets-toggle <STATE> <INSET>
4397 \begin_layout Description
4398 Params <STATE>: <toggle|open|close> default: toggle
4399 \begin_inset Newline newline
4402 <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all
4406 \begin_layout Description
4407 Origin leeming, 30 Mar 2004
4410 \begin_layout Subsection*
4411 LFUN_GRAPHICS_GROUPS_UNIFY
4414 \begin_layout Description
4415 Action Unify all graphics insets with the one given as an parameter.
4419 \begin_layout Description
4420 Notion This is internally used for synchronize certain group of graphics
4425 \begin_layout Description
4426 Syntax graphics-groups-unigfy <GRAPHICS_PARAMS>
4429 \begin_layout Description
4430 Params <GRAPHICS_PARAMS>: Parameters for graphics inset (syntax can be seen
4435 \begin_layout Description
4436 Origin sanda, 6 May 2008
4439 \begin_layout Subsection*
4440 LFUN_SET_GRAPHICS_GROUP
4443 \begin_layout Description
4444 Action Set the group for the graphics inset on the cursor position.
4448 \begin_layout Description
4449 Syntax set-graphics-group [<GROUP>]
4452 \begin_layout Description
4453 Params <GROUP>: Id for an existing group.
4454 In case tthe Id is an empty string, the graphics inset is removed from
4459 \begin_layout Description
4460 Origin sanda, 6 May 2008
4463 \begin_layout Subsection*
4464 LFUN_FINISHED_FORWARD
4467 \begin_layout Description
4468 Action Moves the cursor out of the current slice, going forward.
4472 \begin_layout Description
4473 Notion Cursor movement within an inset may be different than cursor movement
4474 in the surrounding text.
4475 This action should be called automatically by the cursor movement within
4476 the inset, when movement within the inset has ceased (reached the end of
4477 the last paragraph, for example), in order to move correctly back into
4478 the surrounding text.
4482 \begin_layout Subsection*
4483 LFUN_FINISHED_BACKWARD
4486 \begin_layout Description
4487 Action Moves the cursor out of the current slice, going backwards.
4491 \begin_layout Description
4492 Notion See also LFUN_FINISHED_FORWARD.
4496 \begin_layout Subsection*
4500 \begin_layout Description
4501 Action Moves the cursor out of the current slice, going right.
4505 \begin_layout Description
4506 Notion See also LFUN_FINISHED_FORWARD
4509 \begin_layout Subsection*
4513 \begin_layout Description
4514 Action Moves the cursor out of the current slice, going left.
4518 \begin_layout Description
4519 Notion See also LFUN_FINISHED_FORWARD.
4523 \begin_layout Subsection*
4527 \begin_layout Description
4528 Action Set language from the current cursor position.
4532 \begin_layout Description
4533 Syntax language <LANG>
4536 \begin_layout Description
4537 Params <LANG>: Requested language.
4538 Look in lib/languages for the list.
4542 \begin_layout Description
4543 Origin Dekel, 2 Mar 2000
4546 \begin_layout Subsection*
4550 \begin_layout Description
4551 Action Goto a label.
4555 \begin_layout Description
4556 Syntax label-goto [<LABEL>]
4559 \begin_layout Description
4560 Params <LABEL>: Requested label.
4561 If no label is given and refernce is on cursor position, Bookmark 0 is
4562 saved and cursor moves to the position of referenced label.
4566 \begin_layout Description
4567 Origin Ale, 6 Aug 1997
4570 \begin_layout Subsection*
4574 \begin_layout Description
4575 Action Inserts label to text or displayed formula.
4579 \begin_layout Description
4580 Syntax label-insert [<LABEL>]
4583 \begin_layout Description
4584 Params <LABEL>: Requested label.
4585 If no label is given dialog requesting name will be opened.
4589 \begin_layout Subsection*
4593 \begin_layout Description
4594 Action Go to the next label or cross-reference.
4598 \begin_layout Description
4599 Syntax reference-next
4602 \begin_layout Description
4603 Origin Dekel, 14 Jan 2001
4606 \begin_layout Subsection*
4610 \begin_layout Description
4611 Action Goto a bookmark.
4615 \begin_layout Description
4616 Notion Moves the cursor to the numbered bookmark, opening the file if necessary.
4617 Note that bookmarsk are saved per-session, not per file.
4621 \begin_layout Description
4622 Syntax bookmark-goto <NUMBER>
4625 \begin_layout Description
4626 Params <NUMBER>: the number of the bookmark to restore.
4630 \begin_layout Description
4631 Origin Dekel, 27 January 2001
4634 \begin_layout Subsection*
4638 \begin_layout Description
4639 Action Save a bookmark.
4643 \begin_layout Description
4644 Notion Saves a numbered bookmark to the sessions file.
4645 The number must be between 1 and 9, inclusive.
4646 Note that bookmarks are saved per-session, not per file.
4650 \begin_layout Description
4651 Syntax bookmark-save <NUMBER>
4654 \begin_layout Description
4655 Params <NUMBER>: the number of the bookmark to save.
4659 \begin_layout Description
4660 Origin Dekel, 27 January 2001
4663 \begin_layout Subsection*
4667 \begin_layout Description
4668 Action Clears the list of saved bookmarks.
4672 \begin_layout Description
4673 Syntax bookmark-clear
4676 \begin_layout Description
4677 Origin bpeng, 31 October 2006
4680 \begin_layout Subsection*
4684 \begin_layout Description
4685 Action Open the given help file according to the language setting.
4689 \begin_layout Description
4690 Syntax help-open <FILE>[.lyx]
4693 \begin_layout Description
4694 Params <FILE>: any document from (/usr/share/)doc directory.
4698 \begin_layout Description
4699 Origin Jug, 27 Jun 1999
4702 \begin_layout Subsection*
4706 \begin_layout Description
4707 Action Terminates the current LyX instance.
4711 \begin_layout Description
4712 Notion Terminates the current LyX instance, asking whether to save modified
4717 \begin_layout Description
4721 \begin_layout Subsection*
4725 \begin_layout Description
4726 Action Toggles visibility of a given toolbar between on/off/auto.
4730 \begin_layout Description
4731 Notion Skiping "auto" when allowauto is false.
4735 \begin_layout Description
4736 Syntax toolbar-toggle <NAME> [allowauto]
4739 \begin_layout Description
4740 Params <NAME>: standard|extra|table|math|mathmacrotemplate| minibuffer|review|vi
4741 ew/update|math_panels|vcs
4744 \begin_layout Description
4745 Origin Edwin, 21 May 2007
4748 \begin_layout Subsection*
4752 \begin_layout Description
4753 Action Opens the menu given by its name.
4757 \begin_layout Description
4758 Syntax menu-open <NAME>
4761 \begin_layout Description
4762 Params <NAME>: menu name.
4763 See various .inc files in lib/ui for candidates.
4767 \begin_layout Subsection*
4771 \begin_layout Description
4772 Action Various UI visibility-toggling actions.
4776 \begin_layout Description
4777 Syntax ui-toggle <statusbar|menubar|frame|fullscreen>
4780 \begin_layout Description
4781 Params statusbar : Toggle visibility of the statusbar.
4783 \begin_inset Newline newline
4786 menubar : Toggle visibility of the menubar.
4788 \begin_inset Newline newline
4791 scrollbar : Toggle visibility of the scrollbar.
4793 \begin_inset Newline newline
4796 frame : Toggle visibility of the frames around editing window.
4798 \begin_inset Newline newline
4801 fullscreen : Toggle fullscreen mode.
4802 This also covers calling the previous functions.
4803 However LFUN_TOOLBAR_TOGGLE for the custom tweaks of the toolbars should
4808 \begin_layout Description
4809 Origin sanda, 9 Feb 2007
4812 \begin_layout Subsection*
4816 \begin_layout Description
4817 Action Creates new empty LyX window.
4821 \begin_layout Description
4822 Notion Already opened documents from the previous window can be found under
4827 \begin_layout Description
4828 Syntax window-new [<GEOMETRY>]
4831 \begin_layout Description
4832 Params <GEOMETRY>: pass the geometry of the window.
4833 This parameter is currently accepted only on Windows platform.
4837 \begin_layout Description
4838 Origin Abdel, 21 Oct 2006
4841 \begin_layout Subsection*
4845 \begin_layout Description
4846 Action Closes the current LyX window.
4850 \begin_layout Description
4854 \begin_layout Description
4855 Origin Abdel, 23 Oct 2006
4858 \begin_layout Subsection*
4862 \begin_layout Description
4863 Action Creates another split view of current buffer.
4867 \begin_layout Description
4868 Notion All split views act in the same way indpendently.
4872 \begin_layout Description
4873 Syntax split-view <vertical|horizontal>
4876 \begin_layout Description
4877 Params horizontal : The work areas are laid out side by side.
4879 \begin_inset Newline newline
4882 vertical : The work areas laid out vertically.
4886 \begin_layout Description
4887 Origin Abdel, 20 Feb 2008
4890 \begin_layout Subsection*
4891 LFUN_CLOSE_TAB_GROUP
4894 \begin_layout Description
4895 Action Close the current tab group.
4899 \begin_layout Description
4900 Notion This only closes the work areas, not the buffer themselves.
4901 The still opened buffers can be visualized in another tab group.
4905 \begin_layout Description
4906 Syntax close-tab-group
4909 \begin_layout Description
4910 Origin Abdel, 21 Feb 2008
4913 \begin_layout Subsection*
4917 \begin_layout Description
4918 Action Shows hidden dialog or create new one for a given function/inset
4923 \begin_layout Description
4924 Syntax dialog-show <NAME> [<DATA>]
4927 \begin_layout Description
4928 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
4930 \begin_inset Newline newline
4933 document|errorlist|ert|external|file|findreplace|float|graphics|
4934 \begin_inset Newline newline
4937 include|index|info|nomenclature|label|log|mathdelimiter|mathmatrix|
4938 \begin_inset Newline newline
4941 note|paragraph|prefs|print|ref|sendto|space|spellchecker|symbols|
4942 \begin_inset Newline newline
4945 tabular|tabularcreate|thesaurus|texinfo|toc|href|view-source|vspace
4946 \begin_inset Newline newline
4949 wrap|listings|<SPECIAL>
4950 \begin_inset Newline newline
4953 <SPECIAL>: latexlog|vclog
4954 \begin_inset Newline newline
4957 <DATA>: data, usually settings for the given dialog.
4958 Use debug mode for the details.
4962 \begin_layout Description
4963 Origin leeming, 17 Jun 2003
4966 \begin_layout Subsection*
4967 LFUN_DIALOG_SHOW_NEW_INSET
4970 \begin_layout Description
4971 Action Shows hidden dialog or create new one for a given inset settings
4976 \begin_layout Description
4977 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given
4982 \begin_layout Description
4983 Syntax dialog-show-new-inset <NAME> [<DATA>]
4986 \begin_layout Description
4987 Params See LFUN_DIALOG_SHOW .
4991 \begin_layout Description
4992 Origin leeming, 25 Feb 2003
4995 \begin_layout Subsection*
4999 \begin_layout Description
5000 Action Updates the dialog values from the inset/paragraph/document.
5004 \begin_layout Description
5005 Syntax dialog-update <NAME>
5008 \begin_layout Description
5009 Params <NAME>: paragraph|prefs|<INSET>
5010 \begin_inset Newline newline
5016 \begin_layout Description
5017 Origin leeming, 25 Feb 2003
5020 \begin_layout Subsection*
5024 \begin_layout Description
5025 Action Hides showed dialog.
5026 Counterpart to LFUN_DIALOG_SHOW .
5030 \begin_layout Description
5031 Syntax dialog-hide <NAME>
5034 \begin_layout Description
5035 Params See LFUN_DIALOG_SHOW .
5039 \begin_layout Description
5040 Origin leeming, 25 Feb 2003
5043 \begin_layout Subsection*
5047 \begin_layout Description
5048 Action Toggles dialog between showed/hidden state.
5052 \begin_layout Description
5053 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
5057 \begin_layout Description
5058 Syntax dialog-toggle <NAME> [<DATA>]
5061 \begin_layout Description
5062 Params See LFUN_DIALOG_SHOW .
5066 \begin_layout Description
5067 Origin JSpitzm, 30 Apr 2007
5070 \begin_layout Subsection*
5071 LFUN_DIALOG_DISCONNECT_INSET
5074 \begin_layout Description
5075 Action Closes opened connection to opened inset.
5079 \begin_layout Description
5080 Notion Connection is used for apply functions.
5084 \begin_layout Description
5085 Syntax dialog-disconnect-inset <INSET-NAME>
5088 \begin_layout Description
5089 Origin leeming, 25 Feb 2003
5092 \begin_layout Subsection*
5096 \begin_layout Description
5097 Action This function is called when mouse button is pressed (inside workarea).Act
5098 ion depends on the context.
5102 \begin_layout Description
5103 Notion This is internal LFUN, not to be used by users.
5107 \begin_layout Description
5108 Origin Andre, 9 Aug 2002
5111 \begin_layout Subsection*
5115 \begin_layout Description
5116 Action This function is called when double click on mouse button is pressed
5118 Action depends on the context.
5122 \begin_layout Description
5123 Notion This is internal LFUN, not to be used by users.
5127 \begin_layout Description
5128 Origin Andre, 9 Aug 2002
5131 \begin_layout Subsection*
5135 \begin_layout Description
5136 Action This function is called when triple click on mouse button is pressed
5138 Action depends on the context.
5142 \begin_layout Description
5143 Notion This is internal LFUN, not to be used by users.
5147 \begin_layout Description
5148 Origin Andre, 9 Aug 2002
5151 \begin_layout Subsection*
5155 \begin_layout Description
5156 Action This function is called when mouse cursor is moving over the text.Action
5157 depends on the context.
5161 \begin_layout Description
5162 Notion This is internal LFUN, not to be used by users.
5166 \begin_layout Description
5167 Origin Andre, 9 Aug 2002
5170 \begin_layout Subsection*
5174 \begin_layout Description
5175 Action This function is called when mouse button is released (inside workarea).Ac
5176 tion depends on the context.
5180 \begin_layout Description
5181 Notion This is internal LFUN, not to be used by users.
5185 \begin_layout Description
5186 Origin Andre, 9 Aug 2002
5189 \begin_layout Subsection*
5193 \begin_layout Description
5194 Action Turn off the loaded keyboard map.
5198 \begin_layout Description
5202 \begin_layout Subsection*
5206 \begin_layout Description
5207 Action Turn on the primary keyboard map.
5211 \begin_layout Description
5212 Notion Maps were widely used in past, when X-windows didn't have nowadays
5214 They can be still used to maintain uniform keyboard layout across the various
5217 \begin_inset Newline newline
5220 The language is to be set in the Preferences dialog.
5224 \begin_layout Description
5225 Syntax keymap-primary
5228 \begin_layout Subsection*
5229 LFUN_KEYMAP_SECONDARY
5232 \begin_layout Description
5233 Action Turn on the secondary keyboard map.
5237 \begin_layout Description
5238 Syntax keymap-secondary
5241 \begin_layout Subsection*
5245 \begin_layout Description
5246 Action Toggles keyboard maps (first/second/off).
5250 \begin_layout Description
5251 Syntax keymap-toggle
5254 \begin_layout Description
5255 Origin leeming, 30 Mar 2004
5258 \begin_layout Subsection*
5259 LFUN_SERVER_GET_LAYOUT
5262 \begin_layout Description
5263 Action Returns the current layout (that is environment) name on the cursor
5268 \begin_layout Description
5269 Syntax server-get-layout
5272 \begin_layout Subsection*
5273 LFUN_SERVER_GET_FILENAME
5276 \begin_layout Description
5277 Action Returns path and file name of the currently edited document.
5281 \begin_layout Description
5282 Syntax server-get-filename
5285 \begin_layout Subsection*
5286 LFUN_SERVER_GOTO_FILE_ROW
5289 \begin_layout Description
5290 Action Sets the cursor position based on the row number of generated TeX
5295 \begin_layout Description
5296 Syntax server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
5299 \begin_layout Description
5300 Origin Edmar, 23 Dec 1998
5303 \begin_layout Subsection*
5307 \begin_layout Description
5308 Action Sends notify message about the last key-sequence to client.
5312 \begin_layout Description
5313 Notion This can be used to grab last key-sequence used inside the LyX window.
5317 \begin_layout Description
5318 Syntax server-notify
5321 \begin_layout Subsection*
5325 \begin_layout Description
5326 Action Sets the cursor position based on the editing area coordinates (similar
5327 as clicking on that point with left mouse button).
5331 \begin_layout Description
5332 Syntax server-set-xy <X> <Y>
5335 \begin_layout Subsection*
5339 \begin_layout Description
5340 Action Returns the coordinates of cursor position in the editing area.
5344 \begin_layout Description
5345 Syntax server-get-xy
5348 \begin_layout Subsection*
5352 \begin_layout Description
5353 Action Generates the code (literate programming).
5357 \begin_layout Description
5358 Notion Latex file with extension literate_extension is generated.
5359 Then LyX invokes build_command (with a default of``make'') to generate
5360 the code and build_error_filter to process the compilation error messages.
5362 \begin_inset Newline newline
5365 In case you want to process your literate file with a script, or some other
5366 program, just insert in your lyxrc file an entry with:
5367 \begin_inset Newline newline
5370 build_command "my_script my_arguments"
5371 \begin_inset Newline newline
5374 The build_error_filter differs from the literate_error_filter only in that
5375 the former will identify error messages from your compiler.
5379 \begin_layout Description
5380 Syntax build-program
5383 \begin_layout Subsection*
5384 LFUN_BUFFER_AUTO_SAVE
5387 \begin_layout Description
5388 Action Saves the current buffer to a temporary file.
5392 \begin_layout Description
5393 Notion Saves the current buffer to a file named "#filename#".
5394 This LFUN is called automatically by LyX, to "autosave" the current buffer.
5398 \begin_layout Description
5399 Syntax buffer-auto-save
5402 \begin_layout Subsection*
5403 LFUN_BUFFER_CHILD_OPEN
5406 \begin_layout Description
5407 Action Loads the given child document.
5411 \begin_layout Description
5412 Notion The current document is treated as a parent.
5416 \begin_layout Description
5417 Syntax buffer-child-open <FILE>
5420 \begin_layout Description
5421 Params <FILE>: Filename of the child.
5422 The directory of the parent is assumed by default.
5426 \begin_layout Description
5427 Origin Ale, 28 May 1997
5430 \begin_layout Subsection*
5434 \begin_layout Description
5435 Action Runs chktex for the current document.
5439 \begin_layout Description
5440 Syntax buffer-chktex
5443 \begin_layout Description
5444 Origin Asger, 30 Oct 1997
5447 \begin_layout Subsection*
5448 LFUN_BUFFER_TOGGLE_COMPRESSION
5451 \begin_layout Description
5452 Action Toggles compression of the current document on/off.
5456 \begin_layout Description
5457 Syntax buffer-toggle-compression
5460 \begin_layout Description
5461 Origin bpeng, 27 Apr 2006
5464 \begin_layout Subsection*
5468 \begin_layout Description
5469 Action Closes the current buffer.
5473 \begin_layout Description
5474 Notion Closes the current buffer, asking whether to save it, etc, if the
5475 buffer has been modified.
5479 \begin_layout Description
5483 \begin_layout Subsection*
5487 \begin_layout Description
5488 Action Exports the current buffer (document) to the given format.
5492 \begin_layout Description
5493 Syntax buffer-export <FORMAT>
5496 \begin_layout Description
5497 Params <FORMAT> is either "custom" or one of the formats which you can find
5498 in Tools->Preferences->File formats->Format.
5499 Usual format you will enter is "pdf2" (pdflatex), "pdflatex" (plain tex
5500 for pdflatex) or "ps" for postscript.
5502 \begin_inset Newline newline
5505 In case of "custom" you will be asked for a format you want to start from
5506 and for the command that you want to apply to this format.
5507 Internally the control is then passed to LFUN_BUFFER_EXPORT_CUSTOM.
5511 \begin_layout Description
5512 Origin Lgb, 29 Jul 1997
5515 \begin_layout Subsection*
5516 LFUN_BUFFER_EXPORT_CUSTOM
5519 \begin_layout Description
5520 Action Exports the current buffer (document) from the given format using
5521 the given command on it.
5525 \begin_layout Description
5526 Syntax buffer-export-custom <FORMAT> <COMMAND>
5529 \begin_layout Description
5530 Params <FORMAT> format to start from (LyX will care to produce such intermediate
5533 \begin_inset Newline newline
5536 <COMMAND> this command will be launched on the file.
5537 Note that you can use "$$FName" string to qualify the intermediate file.
5541 \begin_layout Description
5542 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
5545 \begin_layout Description
5546 Origin leeming, 27 Mar 2004
5549 \begin_layout Subsection*
5553 \begin_layout Description
5554 Action Prints the current document.
5558 \begin_layout Description
5559 Notion Many settings can be given via the preferences dialog.
5563 \begin_layout Description
5564 Syntax buffer-print <TARGET> <TARGET-NAME> <COMMAND>
5567 \begin_layout Description
5568 Params <TARGET> is either "printer" or "file".
5570 \begin_inset Newline newline
5573 <TARGER-NAME> is either "default" or file name or printer name.
5575 \begin_inset Newline newline
5578 <COMMAND> command ensuring the printing job.
5582 \begin_layout Description
5583 Sample buffer-print file "/trash/newfile1.ps" "dvips"
5586 \begin_layout Description
5587 Origin leeming, 28 Mar 2004
5590 \begin_layout Subsection*
5594 \begin_layout Description
5595 Action Import a given file as a lyx document.
5599 \begin_layout Description
5600 Notion File can be imported iff lyx file format is (transitively) reachable
5601 via defined convertors in preferences.
5602 Look into File->Import menu to get an idea of the currently active import
5607 \begin_layout Description
5608 Syntax buffer-import <FORMAT> [<FILE>]
5611 \begin_layout Description
5612 Origin Asger, 24 Jul 1998
5615 \begin_layout Subsection*
5619 \begin_layout Description
5620 Action Creates a new buffer (that is, document).
5624 \begin_layout Description
5625 Notion Implicit path can be set in Preferences dialog.
5629 \begin_layout Description
5630 Syntax buffer-new [<FILE>]
5633 \begin_layout Description
5634 Params <FILE>: filename of created file with absolute path.
5638 \begin_layout Subsection*
5639 LFUN_BUFFER_NEW_TEMPLATE
5642 \begin_layout Description
5643 Action Creates a new buffer (that is, document) from a template.
5647 \begin_layout Description
5648 Notion Path for new files and templates can be set in Preferences dialog.
5649 Template will be asked for via Open-dialog.
5653 \begin_layout Description
5654 Syntax buffer-new-template [<FILE>]
5657 \begin_layout Description
5658 Params <FILE>: filename of created file with absolute path.
5662 \begin_layout Subsection*
5666 \begin_layout Description
5667 Action Reverts opened document.
5671 \begin_layout Description
5672 Syntax buffer-reload
5675 \begin_layout Description
5676 Origin Asger, 2 Feb 1997
5679 \begin_layout Subsection*
5683 \begin_layout Description
5684 Action Switch to the given buffer.
5688 \begin_layout Description
5689 Notion This is useful also in case you need simultaneously more views of
5690 the edited document in different LyX windows.
5694 \begin_layout Description
5695 Syntax buffer-new-template <BUFFER>
5698 \begin_layout Description
5699 Params <BUFFER>: already opened document which is to be shown.
5703 \begin_layout Subsection*
5704 LFUN_BUFFER_TOGGLE_READ_ONLY
5707 \begin_layout Description
5708 Action Toggle editing mode of the current document between read/write and
5713 \begin_layout Description
5714 Notion In the ->Readonly mode checks-in/commits the data if the file is
5715 under version control.
5716 In the Readonly-> mode checkouts the data from repository.
5718 \begin_inset Newline newline
5721 If these operations fail, buffer won't be toggled.
5725 \begin_layout Description
5726 Syntax buffer-toggle-read-only
5729 \begin_layout Description
5730 Origin Lgb, 27 May 1997
5733 \begin_layout Subsection*
5737 \begin_layout Description
5738 Action Displays current buffer in chosen format.
5742 \begin_layout Description
5743 Notion Displays the contents of the current buffer in the chosen format,
5744 for example, PDF or DVI.
5745 This runs the necessary converter, calls the defined viewer, and so forth.
5749 \begin_layout Description
5750 Syntax buffer-view <FORMAT>
5753 \begin_layout Description
5754 Params <FORMAT>: The format to display, where this is one of the formats
5755 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
5759 \begin_layout Subsection*
5763 \begin_layout Description
5764 Action Exports the current document and put the result into the temporary
5769 \begin_layout Description
5770 Notion In case you are already viewing the exported document (see LFUN_BUFFER_VI
5771 EW) the output will be rewriten - updated.
5772 This is useful in case your viewer is able to detect such changes (e.g.
5773 ghostview for postscript).
5777 \begin_layout Description
5778 Syntax buffer-update <FORMAT>
5781 \begin_layout Description
5782 Params <FORMAT>: The format to display, where this is one of the formats
5783 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
5787 \begin_layout Description
5788 Origin Dekel, 5 Aug 2000
5791 \begin_layout Subsection*
5795 \begin_layout Description
5796 Action Saves the current buffer.
5800 \begin_layout Description
5801 Notion Saves the current buffer to disk, using the filename that is already
5802 associated with the buffer, asking for one if none is yet assigned.
5806 \begin_layout Description
5810 \begin_layout Subsection*
5811 LFUN_BUFFER_WRITE_AS
5814 \begin_layout Description
5815 Action Rename and save current buffer.
5819 \begin_layout Description
5820 Syntax buffer-write-as <FILENAME>
5823 \begin_layout Description
5824 Params <FILENAME>: New name of the buffer/file.
5825 A relative path is with respect to the original location of the buffer/file.
5829 \begin_layout Subsection*
5830 LFUN_BUFFER_WRITE_ALL
5833 \begin_layout Description
5834 Action Save all changed documents.
5838 \begin_layout Description
5839 Syntax buffer-write-all
5842 \begin_layout Description
5843 Origin rgh, gpothier 6 Aug 2007
5846 \begin_layout Subsection*
5850 \begin_layout Description
5851 Action Switch to the next opened document.
5855 \begin_layout Description
5856 Notion Note that this does not necessarily mean next in tabbar (for full
5857 list see View menu).
5861 \begin_layout Description
5865 \begin_layout Subsection*
5866 LFUN_BUFFER_PREVIOUS
5869 \begin_layout Description
5870 Action Switch to the previous opened document.
5874 \begin_layout Description
5875 Syntax buffer-previous
5878 \begin_layout Subsection*
5879 LFUN_MASTER_BUFFER_UPDATE
5882 \begin_layout Description
5883 Action When run from a child document, this updates (exports) document built
5884 from the master buffer.
5885 If a master is not found, it updates the current buffer.
5889 \begin_layout Description
5890 Syntax master-buffer-update
5893 \begin_layout Description
5894 Origin Tommaso, 20 Sep 2007
5897 \begin_layout Subsection*
5898 LFUN_MASTER_BUFFER_VIEW
5901 \begin_layout Description
5902 Action When run from a child document, this command shows a preview built
5903 from the master buffer.
5904 If a master is not found, it previews the current buffer.
5908 \begin_layout Description
5909 Syntax master-buffer-view
5912 \begin_layout Description
5913 Origin Tommaso, 20 Sep 2007
5916 \begin_layout Subsection*
5917 LFUN_BUFFER_LANGUAGE
5920 \begin_layout Description
5921 Action Set language of the current document.
5925 \begin_layout Description
5926 Syntax buffer-language <LANG>
5929 \begin_layout Description
5930 Params <LANG>: language name.
5931 See lib/languages for list.
5935 \begin_layout Description
5936 Origin leeming, 30 Mar 2004
5939 \begin_layout Subsection*
5940 LFUN_BUFFER_SAVE_AS_DEFAULT
5943 \begin_layout Description
5944 Action Save the current document settings as default.
5948 \begin_layout Description
5949 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
5953 \begin_layout Description
5954 Syntax buffer-save-as-default [<ARGS>]
5957 \begin_layout Description
5958 Params <ARGS>: contains the particular settings to be saved.
5959 They obey the syntax you can find in document header of usual .lyx file.
5963 \begin_layout Description
5964 Origin leeming, 30 Mar 2004
5967 \begin_layout Subsection*
5968 LFUN_BUFFER_PARAMS_APPLY
5971 \begin_layout Description
5972 Action Apply the given settings to the current document.
5976 \begin_layout Description
5977 Syntax buffer-params-apply [<ARGS>]
5980 \begin_layout Description
5981 Params <ARGS>: contains the particular settings to be saved.
5982 They obey the syntax you can find in document header of usual .lyx file.
5986 \begin_layout Description
5987 Origin leeming, 30 Mar 2004
5990 \begin_layout Subsection*
5994 \begin_layout Description
5995 Action Inserts another LyX file.
5999 \begin_layout Description
6000 Syntax file-insert [<FILE>]
6003 \begin_layout Description
6004 Params <FILE>: Filename to be inserted.
6008 \begin_layout Subsection*
6009 LFUN_FILE_INSERT_PLAINTEXT
6012 \begin_layout Description
6013 Action Inserts plain text file.
6017 \begin_layout Description
6018 Syntax file-insert-plaintext [<FILE>]
6021 \begin_layout Description
6022 Params <FILE>: Filename to be inserted.
6026 \begin_layout Description
6027 Origin CFO-G, 19 Nov 1997
6030 \begin_layout Subsection*
6031 LFUN_FILE_INSERT_PLAINTEXT_PARA
6034 \begin_layout Description
6035 Action Inserts plain text file as paragraph (i.e.
6040 \begin_layout Description
6041 Syntax file-insert-plaintext-para [<FILE>]
6044 \begin_layout Description
6045 Params <FILE>: Filename to be inserted.
6049 \begin_layout Description
6050 Origin Levon, 14 Feb 2001
6053 \begin_layout Subsection*
6057 \begin_layout Description
6058 Action Open LyX document.
6062 \begin_layout Description
6063 Syntax file-open [<FILE>]
6066 \begin_layout Description
6067 Params <FILE>: Filename to be opened.
6071 \begin_layout Subsection*
6075 \begin_layout Description
6076 Action Executes a command defined in a .def file.
6080 \begin_layout Description
6081 Notion The definitions are by default read from lib/commands/default.def.
6083 \begin_inset Newline newline
6086 A .def file allows to define a command with
6088 define "<NAME>" "<LFUN>" where <NAME> is the name of the new command and
6089 <LFUN> is the lfun code to be executed (see e.g.
6090 LFUN_COMMAND_SEQUENCE).
6093 def_file "FileName" allows to include another .def file.
6095 \begin_inset Newline newline
6098 This is particularly useful in connection with toolbar buttons: Since the
6099 name of the button image for this lfun is lib/images/commands/<NAME>.png
6100 this is the way to assign an image to a complex command-sequence.
6104 \begin_layout Description
6108 \begin_layout Description
6109 Params <NAME>: Name of the command that must be called.
6113 \begin_layout Description
6114 Origin broider, 2 Oct 2007
6117 \begin_layout Subsection*
6121 \begin_layout Description
6122 Action Simulate halting Meta key (Alt key on PCs).
6126 \begin_layout Description
6127 Notion Used for buffer editation not for GUI control.
6131 \begin_layout Description
6135 \begin_layout Subsection*
6139 \begin_layout Description
6140 Action Cancels sequence prepared by LFUN_META_PREFIX .
6144 \begin_layout Description
6148 \begin_layout Subsection*
6149 LFUN_COMMAND_EXECUTE
6152 \begin_layout Description
6153 Action Opens the minibuffer toolbar so that the user can type in there.
6157 \begin_layout Description
6158 Notion Usually bound to M-x shortcut.
6162 \begin_layout Description
6163 Syntax command-execute
6166 \begin_layout Subsection*
6170 \begin_layout Description
6171 Action Return the current key sequence and available options as a string.
6175 \begin_layout Description
6176 Notion No options are added if no current map exists.
6178 \begin_inset Newline newline
6181 This is probably usable only with connection to lyxserver.
6185 \begin_layout Description
6186 Syntax command-prefix
6189 \begin_layout Subsection*
6190 LFUN_COMMAND_SEQUENCE
6193 \begin_layout Description
6194 Action Run more commands (LFUN and its parameters) in a sequence.
6198 \begin_layout Description
6199 Syntax command-sequence <CMDS>
6202 \begin_layout Description
6203 Params <CMDS>: Sequence of commands separated by semicolons.
6207 \begin_layout Description
6208 Sample command-sequence cut; ert-insert; self-insert ; paste; self-insert
6212 \begin_layout Description
6213 Origin Andre, 11 Nov 1999
6216 \begin_layout Subsection*
6220 \begin_layout Description
6221 Action Shows message in statusbar (for script purposes).
6225 \begin_layout Description
6226 Syntax message <STRING>
6229 \begin_layout Description
6230 Origin Lgb, 8 Apr 2001
6233 \begin_layout Subsection*
6234 LFUN_PREFERENCES_SAVE
6237 \begin_layout Description
6238 Action Save user preferences.
6242 \begin_layout Description
6243 Syntax preferences-save
6246 \begin_layout Description
6247 Origin Lgb, 27 Nov 1999
6250 \begin_layout Subsection*
6254 \begin_layout Description
6255 Action Reconfigure the automatic settings.
6259 \begin_layout Description
6263 \begin_layout Description
6264 Origin Asger, 14 Feb 1997
6267 \begin_layout Subsection*
6271 \begin_layout Description
6272 Action Apply the given settings to user preferences.
6276 \begin_layout Description
6277 Syntax lyxrc-apply <SETTINGS>
6280 \begin_layout Description
6281 Params <SETTINGS>: settings which are to be set.
6282 Take a look into ~/.lyx/preferences to get an idea which commands to use
6284 lyx::LyXRC::LyXRCTags has the list of possible commands.
6288 \begin_layout Subsection*
6289 LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
6292 \begin_layout Description
6293 Action Determine whether keep cursor inside the editing window regardless
6294 the scrollbar movement.
6298 \begin_layout Description
6299 Syntax toggle-cursor-follows-scrollbar
6302 \begin_layout Description
6303 Origin ARRae, 2 Dec 1997
6306 \begin_layout Subsection*
6310 \begin_layout Description
6311 Action Set the given LyX color to the color defined by the X11 name given.
6315 \begin_layout Description
6316 Notion A new color entry is created if the color is unknown.
6317 Color names can be stored as a part of user settings.
6321 \begin_layout Description
6322 Syntax set-color <LYX_NAME> <X11_NAME>
6325 \begin_layout Description
6326 Origin SLior, 11 Jun 2000
6329 \begin_layout Subsection*
6333 \begin_layout Description
6334 Action Count the statistics (number of words and characters) in the document
6335 or in the given selection.
6339 \begin_layout Description
6340 Notion Note that this function gives the number of words/chars written,
6341 not the number of characters which will be typeset.
6345 \begin_layout Description
6349 \begin_layout Description
6350 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
6353 \begin_layout Subsection*
6354 LFUN_COMPLETION_INLINE
6357 \begin_layout Description
6358 Action Show the inline completion at the cursor position.
6362 \begin_layout Description
6363 Syntax completion-inline
6366 \begin_layout Description
6367 Origin sts, Feb 19 2008
6370 \begin_layout Subsection*
6371 LFUN_COMPLETION_POPUP
6374 \begin_layout Description
6375 Action Show the completion popup at the cursor position.
6379 \begin_layout Description
6380 Syntax completion-popup
6383 \begin_layout Description
6384 Origin sts, Feb 19 2008
6387 \begin_layout Subsection*
6388 LFUN_COMPLETION_COMPLETE
6391 \begin_layout Description
6392 Action Try to complete the word or command at the cursor position.
6396 \begin_layout Description
6400 \begin_layout Description
6401 Origin sts, Feb 19 2008
6404 \begin_layout Subsection*
6405 LFUN_COMPLETION_CANCEL
6408 \begin_layout Description
6409 Action Try to cancel completion, either the popup or the inline completion
6413 \begin_layout Description
6414 Syntax completion-cancel
6417 \begin_layout Description
6418 Origin sts, Sep 07 2008
6421 \begin_layout Subsection*
6422 LFUN_COMPLETION_ACCEPT
6425 \begin_layout Description
6426 Action Accept suggested completion.
6430 \begin_layout Description
6431 Syntax completion-accept
6434 \begin_layout Description
6435 Origin sanda, Sep 08 2008
6438 \begin_layout Subsection*
6439 LFUN_BRANCH_ACTIVATE
6442 \begin_layout Description
6443 Action Activate the branch
6446 \begin_layout Description
6447 Syntax branch-activate <BRANCH>
6450 \begin_layout Description
6451 Params <BRANCH>: The branch to activate
6454 \begin_layout Description
6455 Sample lyx -e pdf2 -x "branch-activate answers" finalexam.lyx
6456 \begin_inset Newline newline
6459 could be used to export a pdf with the answers branch includedwithout one's
6460 having to open LyX and activate the branch manually.
6463 \begin_layout Description
6464 Origin rgh, 27 May 2008
6467 \begin_layout Subsection*
6468 LFUN_BRANCH_ACTIVATE
6471 \begin_layout Description
6472 Action De-activate the branch
6475 \begin_layout Description
6476 Syntax branch-deactivate <BRANCH>
6479 \begin_layout Description
6480 Params <BRANCH>: The branch to deactivate
6483 \begin_layout Description
6484 Origin rgh, 27 May 2008