1 #LyX 2.0 created this file. For more info see http://www.lyx.org/
7 \renewcommand{\descriptionlabel}[1]{\hspace\labelsep\upshape\bfseries #1:}
8 \renewenvironment{description}{\list{}{%
9 \setlength{\itemsep}{-2pt}
10 \advance\leftmargini6\p@ \itemindent-12\p@
11 \labelwidth\z@ \let\makelabel\descriptionlabel}%
16 \use_default_options false
17 \maintain_unincluded_children false
19 \language_package default
24 \font_typewriter default
25 \font_default_family default
26 \use_non_tex_fonts false
33 \default_output_format default
35 \bibtex_command default
36 \index_command default
37 \paperfontsize default
49 \paperorientation portrait
62 \paragraph_separation indent
63 \paragraph_indentation default
64 \quotes_language english
67 \paperpagestyle default
68 \tracking_changes false
77 \begin_layout Section*
78 LFUNs documentation automatically generated 2011-12-15
81 \begin_layout Standard
85 \begin_layout Plain Layout
95 \begin_inset VSpace 1cm
101 \begin_layout Subsection*
105 \begin_layout Description
106 Action Adds an acute accent to the next character typed.
109 \begin_layout Description
113 \begin_layout Subsection*
117 \begin_layout Description
118 Action Adds a breve accent to the next character typed.
121 \begin_layout Description
125 \begin_layout Subsection*
129 \begin_layout Description
130 Action Adds a caron to the next character typed.
133 \begin_layout Description
137 \begin_layout Subsection*
141 \begin_layout Description
142 Action Adds a cedilla to the next character typed.
145 \begin_layout Description
146 Syntax accent-cedilla
149 \begin_layout Subsection*
153 \begin_layout Description
154 Action Adds a circle accent to the next character typed.
157 \begin_layout Description
161 \begin_layout Subsection*
162 LFUN_ACCENT_CIRCUMFLEX
165 \begin_layout Description
166 Action Adds a circumflex to the next character typed.
169 \begin_layout Description
170 Syntax accent-circumflex
173 \begin_layout Subsection*
177 \begin_layout Description
178 Action Adds a dot accent to the next character typed.
181 \begin_layout Description
185 \begin_layout Subsection*
189 \begin_layout Description
190 Action Adds a grave accent to the next character typed.
193 \begin_layout Description
197 \begin_layout Subsection*
198 LFUN_ACCENT_HUNGARIAN_UMLAUT
201 \begin_layout Description
202 Action Adds a Hungarian umlaut to the next character typed.
205 \begin_layout Description
209 \begin_layout Subsection*
213 \begin_layout Description
214 Action Adds a macron to the next character typed.
217 \begin_layout Description
221 \begin_layout Subsection*
225 \begin_layout Description
226 Action Adds an ogonek accent to the next character typed.
229 \begin_layout Description
233 \begin_layout Subsection*
237 \begin_layout Description
238 Action Adds a tie over the next two character typed.
241 \begin_layout Description
242 Notion The following char will finish the tie.
245 \begin_layout Description
249 \begin_layout Subsection*
253 \begin_layout Description
254 Action Adds a tilde over the next character typed.
257 \begin_layout Description
261 \begin_layout Subsection*
265 \begin_layout Description
266 Action Adds an umlaut over the next character typed.
269 \begin_layout Description
273 \begin_layout Subsection*
277 \begin_layout Description
278 Action Adds a bar under the next character typed.
281 \begin_layout Description
282 Syntax accent-underbar
285 \begin_layout Subsection*
289 \begin_layout Description
290 Action Adds a dot under the next character typed.
293 \begin_layout Description
294 Syntax accent-underdot
297 \begin_layout Subsection*
301 \begin_layout Description
302 Action Inserts a caption inset.
305 \begin_layout Description
306 Syntax caption-insert
309 \begin_layout Description
310 Origin Lgb, 18 Jul 2000
313 \begin_layout Subsection*
317 \begin_layout Description
318 Action Inserts the current date.
321 \begin_layout Description
322 Syntax date-insert [<ARG>]
325 \begin_layout Description
326 Params <ARG>: Format of date.
327 The default value (%x) can be set in Preferences->Date format.
328 For possible formats see manual page of strftime function.
331 \begin_layout Description
332 Origin jdblair, 31 Jan 2000
335 \begin_layout Subsection*
339 \begin_layout Description
340 Action Inserts a footnote inset.
343 \begin_layout Description
344 Syntax footnote-insert
347 \begin_layout Description
348 Origin Jug, 7 Mar 2000
351 \begin_layout Subsection*
355 \begin_layout Description
356 Action Inserts an ERT inset.
359 \begin_layout Description
363 \begin_layout Description
364 Origin Jug, 18 Feb 2000
367 \begin_layout Subsection*
371 \begin_layout Description
372 Action Inserts a float inset.
375 \begin_layout Description
376 Syntax float-insert <TYPE>
379 \begin_layout Description
380 Params <TYPE>: type of float depends on the used textclass.
381 Usually "algorithm", "table", "figure" parameters can be given.
384 \begin_layout Description
385 Origin Lgb, 27 Jun 2000
388 \begin_layout Subsection*
389 LFUN_FLOAT_WIDE_INSERT
392 \begin_layout Description
393 Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
396 \begin_layout Description
397 Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
400 \begin_layout Description
401 Syntax float-wide-insert <TYPE>
404 \begin_layout Description
405 Params <TYPE>: type of float depends on the used textclass.
406 Usually "algorithm", "table", "figure" parameters can be given.
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.
421 \begin_layout Description
422 Syntax float-list-insert <TYPE>
425 \begin_layout Description
426 Params <TYPE>: type of float depends on the used textclass.
427 Usually "algorithm", "table", "figure" parameters can be given.
430 \begin_layout Description
431 Origin Lgb, 3 May 2001
434 \begin_layout Subsection*
438 \begin_layout Description
439 Action Inserts floats wrapped by the text around.
442 \begin_layout Description
443 Syntax wrap-insert <TYPE>
446 \begin_layout Description
447 Params <TYPE>: table|figure
450 \begin_layout Description
451 Origin Dekel, 7 Apr 2002
454 \begin_layout Subsection*
458 \begin_layout Description
459 Action Inserts an argument (short title) inset.
462 \begin_layout Description
463 Syntax argument-insert
466 \begin_layout Description
467 Origin vermeer, 12 Aug 2002
470 \begin_layout Subsection*
474 \begin_layout Description
475 Action Inserts a new page.
478 \begin_layout Description
479 Syntax newpage-insert <ARG>
482 \begin_layout Description
483 Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
486 \begin_layout Description
487 Origin uwestoehr, 24 Nov 2007
490 \begin_layout Subsection*
491 LFUN_MARGINALNOTE_INSERT
494 \begin_layout Description
495 Action Inserts a marginal note.
498 \begin_layout Description
499 Syntax marginalnote-insert
502 \begin_layout Description
503 Origin Lgb, 26 Jun 2000
506 \begin_layout Subsection*
510 \begin_layout Description
511 Action Inserts a single unicode character.
514 \begin_layout Description
515 Syntax unicode-insert <CHAR>
518 \begin_layout Description
519 Params <CHAR>: The character to insert, given as its code point, in hexadecimal.
522 \begin_layout Description
523 Sample unicode-insert 0x0100
526 \begin_layout Description
527 Origin Lgb, 22 Oct 2006
530 \begin_layout Subsection*
534 \begin_layout Description
535 Action Inserts a new listings inset.
538 \begin_layout Description
539 Syntax listing-insert
542 \begin_layout Description
543 Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
546 \begin_layout Subsection*
550 \begin_layout Description
551 Action Inserts a new preview inset.
554 \begin_layout Description
555 Syntax preview-insert
558 \begin_layout Description
559 Origin vfr, 28 Mar 2010
562 \begin_layout Subsection*
566 \begin_layout Description
567 Action Insert a tab into a listings inset.
570 \begin_layout Description
571 Notion It also works on a selection.
574 \begin_layout Description
578 \begin_layout Description
579 Origin vfr, Sep 30 2008
582 \begin_layout Subsection*
586 \begin_layout Description
587 Action Delete a tab or up to an equivalent amount of spaces from a listings
591 \begin_layout Description
592 Notion It also works on a selection - it removes a tab or spaces from the
593 beginning of each line spanned by the selection.
594 This is useful if you want to indent/unindent multiple lines in one action.
597 \begin_layout Description
601 \begin_layout Description
602 Origin vfr, Sep 30 2008
605 \begin_layout Subsection*
609 \begin_layout Description
610 Action Inserts quotes according to the type and quote-language preference.
613 \begin_layout Description
614 Notion Currently English, Swedish, German, Polish, French, Danish quotes
618 \begin_layout Description
619 Syntax quote-insert [<TYPE>]
622 \begin_layout Description
623 Params <TYPE>: 'single' for single quotes, otherwise double quotes will
627 \begin_layout Subsection*
631 \begin_layout Description
632 Action Displays shortcuts, lyxrc, package and textclass availability and
633 menu information in a non-editable boxed InsetText.
636 \begin_layout Description
637 Notion Apart from lfun arguments you can use the following method:
638 \begin_inset Newline newline
642 input the type and argument of this inset, e.g.
643 "menu paste", in the work area.
644 \begin_inset Newline newline
648 select the text and run info-insert lfun.
651 \begin_layout Description
652 Syntax info-insert <TYPE> <ARG>
655 \begin_layout Description
656 Params <TYPE>: shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|buffer
657 \begin_inset Newline newline
660 <ARG>: argument for a given type.
661 Look into InsetInfo.h for detailed description.
662 \begin_inset Newline newline
665 shortcut[s]: name of lfun (e.g math-insert
668 \begin_inset Newline newline
671 lyxrc: name of rc_entry (e.g.
673 \begin_inset Newline newline
676 lyxinfo: "version" - used version of LyX
677 \begin_inset Newline newline
680 package: name of latex package (e.g.
682 \begin_inset Newline newline
685 textclass: name of textclass (e.g.
687 \begin_inset Newline newline
690 menu: name of lfun used in menu
691 \begin_inset Newline newline
694 icon: icon of lfun used in toolbar
695 \begin_inset Newline newline
698 buffer: "name"|"path"|"class"|"vcs-tree-revision"| "vcs-revision"|"vcs-a
699 uthor"|"vcs-date"|"vcs-time"
702 \begin_layout Description
703 Sample command-sequence info-insert buffer path; info-insert buffer name
706 \begin_layout Description
707 Origin bpeng, 7 Oct 2007
710 \begin_layout Subsection*
714 \begin_layout Description
715 Action Inserts branch inset.
718 \begin_layout Description
719 Syntax branch-insert <BRANCH-NAME>
722 \begin_layout Description
723 Origin vermeer, 17 Aug 2003
726 \begin_layout Subsection*
730 \begin_layout Description
731 Action Inserts Box inset.
734 \begin_layout Description
735 Syntax box-insert [<TYPE>]
738 \begin_layout Description
739 Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
740 \begin_inset Newline newline
743 Framed is the default one.
746 \begin_layout Description
747 Origin vermeer, 7 Oct 2003
750 \begin_layout Subsection*
754 \begin_layout Description
755 Action Inserts CharStyle, Custom inset or XML short element.
758 \begin_layout Description
759 Notion Look into the Customization manual for more information about these
761 \begin_inset Newline newline
764 To make this command enabled the layout file for the document class you're
765 using has to load the character styles.
766 There are a few contained in the Logical Markup module.
767 You can also of course create some yourself.
768 \begin_inset Newline newline
771 For dissolving the element see LFUN_INSET_DISSOLVE.
774 \begin_layout Description
775 Syntax flex-insert Name
778 \begin_layout Description
779 Params Name: This name must be defined either in your layout file or imported
781 The definition is InsetLayout Name or InsetLayout <Flex:Name>.
782 The Flex: prefix is optional.
785 \begin_layout Description
786 Sample flex-insert Code
789 \begin_layout Subsection*
793 \begin_layout Description
794 Action Inserts the given string (accordingly to the correct keymap).
797 \begin_layout Description
798 Notion Automatically replace the currently selected text.
799 Depends on lyxrc settings "auto_region_delete".
802 \begin_layout Description
803 Syntax self-insert <STRING>
806 \begin_layout Subsection*
810 \begin_layout Description
811 Action Inserts one of horizontal space insets.
814 \begin_layout Description
815 Syntax space-insert <NAME> [<LEN>]
818 \begin_layout Description
819 Params <NAME>: normal, protected, thin, quad, qquad, enspace, enskip, negthinspa
820 ce, hfill, hfill*, dotfill, hrulefill, hspace, hspace*
821 \begin_inset Newline newline
824 <LEN>: length for custom spaces (hspace, hspace* for protected)
827 \begin_layout Description
828 Origin JSpitzm, 20 May 2003, Mar 17 2008
831 \begin_layout Subsection*
832 LFUN_HYPERLINK_INSERT
835 \begin_layout Description
836 Action Inserts hyperlinks into the document (clickable in pdf output).
839 \begin_layout Description
840 Notion Hyperlink target can be set via selection + hyperlink-insert function.
843 \begin_layout Description
844 Syntax href-insert [<TARGET>]
847 \begin_layout Description
848 Origin CFO-G, 21 Nov 1997
851 \begin_layout Subsection*
852 LFUN_SPECIALCHAR_INSERT
855 \begin_layout Description
856 Action Inserts various characters into the document.
859 \begin_layout Description
860 Syntax specialchar-insert <CHAR>
863 \begin_layout Description
864 Params <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots, end-of-sen
865 tence, menu-separator.
868 \begin_layout Description
869 Origin JSpitzm, 6 Dec 2007
872 \begin_layout Subsection*
876 \begin_layout Description
877 Action Inserts a subscript or superscript inset.
880 \begin_layout Description
881 Syntax script-insert <TYPE>
884 \begin_layout Description
885 Params <TYPE>: subscript|superscript
888 \begin_layout Description
889 Origin Georg, 23 Nov 2010
892 \begin_layout Subsection*
896 \begin_layout Description
897 Action Start (or remove) Appendix on the given cursor position.
900 \begin_layout Description
904 \begin_layout Description
905 Origin ettrich, 5 May 1998
908 \begin_layout Subsection*
912 \begin_layout Description
913 Action Inserts Index entry.
916 \begin_layout Description
917 Notion It automatically takes the word on the cursor position.
920 \begin_layout Description
921 Syntax index-insert [<TYPE:Name>]
924 \begin_layout Description
925 Params <TYPE:Name>: name of the index, if multiple indices are defined.
926 with an empty argument, the default index is selected.
929 \begin_layout Description
930 Origin leeming, 3 Aug 2000
933 \begin_layout Subsection*
937 \begin_layout Description
938 Action Inserts list of Index entries on a new page.
941 \begin_layout Description
942 Syntax index-print [<TYPE:Name>]
945 \begin_layout Description
946 Params <TYPE:Name>: name of the index, if multiple indices are defined.
947 with an empty argument, the default index is selected.
950 \begin_layout Description
951 Origin Lgb, 27 Feb 1997
954 \begin_layout Subsection*
958 \begin_layout Description
959 Action Inserts Nomenclature entry.
962 \begin_layout Description
963 Notion It automatically takes the word on the cursor position if no symbol
967 \begin_layout Description
968 Syntax nomencl-insert [<SYMBOL>]
971 \begin_layout Description
972 Origin Ugras, 4 Nov 2006
975 \begin_layout Subsection*
976 LFUN_NOMENCLATURE_PRINT
979 \begin_layout Description
980 Action Inserts list of Nomenclature entries.
983 \begin_layout Description
984 Syntax nomenclature-print
987 \begin_layout Description
988 Origin Ugras, 4 Nov 2006
991 \begin_layout Subsection*
995 \begin_layout Description
996 Action Inserts Note on the current cursor postion, move selection inside
1000 \begin_layout Description
1001 Syntax note-insert [<TYPE>]
1004 \begin_layout Description
1005 Params <TYPE>: <Note|Greyedout|Comment> default: Note
1008 \begin_layout Subsection*
1012 \begin_layout Description
1013 Action Moves the cursor to the begining of next Note inset.
1016 \begin_layout Description
1020 \begin_layout Subsection*
1024 \begin_layout Description
1025 Action Inserts phantom on the current cursor postion, move selection inside
1029 \begin_layout Description
1030 Syntax phantom-insert [<TYPE>]
1033 \begin_layout Description
1034 Params <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
1037 \begin_layout Description
1038 Origin uwestoehr, 30 Jan 2009
1041 \begin_layout Subsection*
1045 \begin_layout Description
1046 Action Inserts a line break or new line.
1049 \begin_layout Description
1050 Syntax newline-insert [<ARG>]
1053 \begin_layout Description
1054 Params <ARG>: <newline|linebreak> default: newline
1057 \begin_layout Description
1058 Origin JSpitzm, 25 Mar 2008
1061 \begin_layout Subsection*
1065 \begin_layout Description
1066 Action Clears the selection.
1067 If no text is selected call LFUN_FINISHED_FORWARD.
1068 Inside math mode jumps out of the math inset.
1071 \begin_layout Description
1075 \begin_layout Description
1076 Origin Lgb, 17 May 2001
1079 \begin_layout Subsection*
1083 \begin_layout Description
1084 Action Moves the cursor one line in downward direction.
1087 \begin_layout Description
1091 \begin_layout Subsection*
1095 \begin_layout Description
1096 Action Moves the cursor one line in upward direction.
1099 \begin_layout Description
1103 \begin_layout Subsection*
1107 \begin_layout Description
1108 Action Moves the cursor one line in downward direction adding the current
1109 position to the selection.
1112 \begin_layout Description
1116 \begin_layout Subsection*
1120 \begin_layout Description
1121 Action Moves the cursor one line in upward direction adding the current
1122 position to the selection.
1125 \begin_layout Description
1129 \begin_layout Subsection*
1133 \begin_layout Description
1134 Action Moves the cursor one page in downward direction.
1137 \begin_layout Description
1141 \begin_layout Subsection*
1145 \begin_layout Description
1146 Action Moves the cursor one page in upward direction.
1149 \begin_layout Description
1153 \begin_layout Subsection*
1154 LFUN_SCREEN_DOWN_SELECT
1157 \begin_layout Description
1158 Action Moves the cursor one screen in downward direction adding the current
1159 position to the selection.
1162 \begin_layout Description
1163 Syntax screen-down-select
1166 \begin_layout Subsection*
1167 LFUN_SCREEN_UP_SELECT
1170 \begin_layout Description
1171 Action Moves the cursor one page in upward direction adding the current
1172 position to the selection.
1175 \begin_layout Description
1176 Syntax screen-up-select
1179 \begin_layout Subsection*
1183 \begin_layout Description
1184 Action Scroll the buffer view.
1187 \begin_layout Description
1188 Notion Only scrolls the screen up or down; does not move the cursor.
1191 \begin_layout Description
1192 Syntax scroll <TYPE> <QUANTITY>
1195 \begin_layout Description
1196 Params <TYPE>: line|page
1197 \begin_inset Newline newline
1200 <QUANTITY>: up|down|<number>
1203 \begin_layout Description
1204 Origin Abdel, Dec 27 2007
1207 \begin_layout Subsection*
1208 LFUN_SCREEN_RECENTER
1211 \begin_layout Description
1212 Action Recenters the screen on the current cursor position.
1215 \begin_layout Description
1216 Syntax screen-recenter
1219 \begin_layout Subsection*
1220 LFUN_SCREEN_SHOW_CURSOR
1223 \begin_layout Description
1224 Action Repositions the screen such that the cursor is visible.
1227 \begin_layout Description
1228 Syntax screen-show-cursor
1231 \begin_layout Description
1232 Origin vfr, 25 Mar 2009
1235 \begin_layout Subsection*
1239 \begin_layout Description
1240 Action Moves the cursor one position logically backwards.
1243 \begin_layout Description
1244 Notion This is not the action which should be bound to the arrow keys, because
1245 backwards may be left or right, depending on the language.
1246 The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions,
1247 which in turn may employ this one.
1250 \begin_layout Description
1251 Syntax char-backward
1254 \begin_layout Subsection*
1255 LFUN_CHAR_BACKWARD_SELECT
1258 \begin_layout Description
1259 Action Moves the cursor one position logically backwards, adding traversed
1260 position to the selection.
1263 \begin_layout Description
1264 Notion See also LFUN_CHAR_BACKWARD.
1267 \begin_layout Description
1268 Syntax char-backward-select
1271 \begin_layout Subsection*
1272 LFUN_CHAR_DELETE_BACKWARD
1275 \begin_layout Description
1276 Action Deletes one character in the backward direction (usually the "BackSpace"
1280 \begin_layout Description
1281 Syntax char-delete-backward
1284 \begin_layout Subsection*
1285 LFUN_CHAR_DELETE_FORWARD
1288 \begin_layout Description
1289 Action Deletes one character in the backward direction (usually the "Delete"
1293 \begin_layout Description
1294 Syntax char-delete-forward
1297 \begin_layout Subsection*
1301 \begin_layout Description
1302 Action Moves the cursor one position logically forward.
1305 \begin_layout Description
1306 Notion This is not the action which should be bound to the arrow keys, because
1307 forward may be left or right, depending on the language.
1308 The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions,
1309 which in turn may employ this one.
1312 \begin_layout Description
1316 \begin_layout Subsection*
1317 LFUN_CHAR_FORWARD_SELECT
1320 \begin_layout Description
1321 Action Moves the cursor one position logically forward, adding traversed
1322 position to the selection.
1325 \begin_layout Description
1326 Notion See also LFUN_CHAR_FORWARD.
1329 \begin_layout Description
1330 Syntax char-forward-select
1333 \begin_layout Subsection*
1337 \begin_layout Description
1338 Action Moves the cursor one position "to the left".
1341 \begin_layout Description
1342 Notion This is the action which should be taken when the "left" key is pressed.
1343 Generally, it moves the cursor one position to the left.
1344 However, in Bidi text this become slightly more complicated, and there
1345 are different modes of cursor movement.
1346 In "visual mode", this moves left, plain and simple.
1347 In "logical mode", movement is logically forward in RTL paragraphs, and
1348 logically backwards in LTR paragraphs.
1351 \begin_layout Description
1355 \begin_layout Subsection*
1356 LFUN_CHAR_LEFT_SELECT
1359 \begin_layout Description
1360 Action Moves the cursor one position "to the left", adding traversed position
1364 \begin_layout Description
1365 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1368 \begin_layout Description
1369 Syntax char-left-select
1372 \begin_layout Subsection*
1376 \begin_layout Description
1377 Action Moves the cursor one position "to the right".
1380 \begin_layout Description
1381 Notion This is the action which should be taken when the "right" key is
1383 Generally, it moves the cursor one position to the right.
1384 However, in Bidi text this become slightly more complicated, and there
1385 are different modes of cursor movement.
1386 In "visual mode", this moves right, plain and simple.
1387 In "logical mode", movement is logically forward in LTR paragraphs, and
1388 logically backwards in RTL paragraphs.
1391 \begin_layout Description
1395 \begin_layout Subsection*
1396 LFUN_CHAR_RIGHT_SELECT
1399 \begin_layout Description
1400 Action Moves the cursor one position "to the right", adding traversed position
1404 \begin_layout Description
1405 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1408 \begin_layout Description
1409 Syntax char-right-select
1412 \begin_layout Subsection*
1416 \begin_layout Description
1417 Action Moves the cursor to the logically previous beginning of a word.
1420 \begin_layout Description
1421 Notion This is not the action which should be bound to the arrow keys, because
1422 backwards may be left or right, depending on the language.
1423 The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
1424 which in turn may employ this one.
1427 \begin_layout Description
1428 Syntax word-backward
1431 \begin_layout Subsection*
1432 LFUN_WORD_BACKWARD_SELECT
1435 \begin_layout Description
1436 Action Moves the cursor to the logically previous beginning of a word, adding
1437 the logically traversed text to the selection.
1440 \begin_layout Description
1441 Notion See also LFUN_WORD_BACKWARD.
1444 \begin_layout Description
1445 Syntax word-backward-select
1448 \begin_layout Subsection*
1449 LFUN_WORD_DELETE_BACKWARD
1452 \begin_layout Description
1453 Action Deletes characters to the begining of the word (usually the "C+BackSpace"
1457 \begin_layout Description
1458 Syntax word-delete-backward
1461 \begin_layout Subsection*
1462 LFUN_WORD_DELETE_FORWARD
1465 \begin_layout Description
1466 Action Deletes characters to the end of the word (usually the "C+Delete"
1470 \begin_layout Description
1471 Syntax word-delete-forward
1474 \begin_layout Subsection*
1475 LFUN_WORD_FIND_FORWARD
1478 \begin_layout Description
1479 Action Search for a given string in forward direction.
1482 \begin_layout Description
1483 Notion Case sensitive, match words.
1484 If no argument given, last search repeated.
1487 \begin_layout Description
1488 Syntax word-find-forward [<STRING>]
1491 \begin_layout Description
1492 Origin Etienne, 16 Feb 1998
1495 \begin_layout Subsection*
1496 LFUN_WORD_FIND_BACKWARD
1499 \begin_layout Description
1500 Action Search for a given string in backward direction.
1503 \begin_layout Description
1504 Notion Case sensitive, match words.
1505 If no argument given, last search repeated.
1508 \begin_layout Description
1509 Syntax word-find-backward [<STRING>]
1512 \begin_layout Description
1513 Origin Etienne, 20 Feb 1998
1516 \begin_layout Subsection*
1520 \begin_layout Description
1521 Action Search for next occurence of a string.
1524 \begin_layout Description
1525 Syntax word-find [<DATA>]
1528 \begin_layout Description
1529 Params <DATA>: data encoded from Find dialog (see lyx::find2string()).
1530 If no parameter is given, search with last find-dialog data is used for
1535 \begin_layout Description
1536 Origin Andre, Jan 7 2004
1539 \begin_layout Subsection*
1543 \begin_layout Description
1544 Action Replace a string in the document.
1547 \begin_layout Description
1548 Syntax word-replace [<DATA>]
1551 \begin_layout Description
1552 Params <DATA>: data is of the form "<replace>
1553 \begin_inset Newline newline
1557 \begin_inset Newline newline
1560 <casesensitive> <matchword> <all> <forward>"
1563 \begin_layout Description
1564 Origin Andre, Jan 7 2004
1567 \begin_layout Subsection*
1571 \begin_layout Description
1572 Action Search for next occurence of a pattern.
1575 \begin_layout Description
1576 Syntax word-findadv [<DATA>]
1579 \begin_layout Description
1580 Params <DATA>: data encoded from FindAdv dialog (see lyx::findadv2string()).
1581 If no parameter is given, search with last find-dialog data is used for
1586 \begin_layout Description
1587 Origin Tommaso, Nov 15 2007
1590 \begin_layout Subsection*
1594 \begin_layout Description
1595 Action Moves the cursor to the logically next beginning of a word.
1598 \begin_layout Description
1599 Notion This is not the action which should be bound to the arrow keys, because
1600 forward may be left or right, depending on the language.
1601 The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
1602 which in turn may employ this one.
1605 \begin_layout Description
1609 \begin_layout Subsection*
1610 LFUN_WORD_FORWARD_SELECT
1613 \begin_layout Description
1614 Action Moves the cursor to the logically next beginning of a word, adding
1615 the logically traversed text to the selection.
1618 \begin_layout Description
1619 Notion See also LFUN_WORD_FORWARD.
1622 \begin_layout Description
1623 Syntax word-forward-select
1626 \begin_layout Subsection*
1630 \begin_layout Description
1631 Action Moves the cursor to the next beginning of a word "on the left".
1634 \begin_layout Description
1635 Notion This is the action which should be taken when the (e.g., ctrl-) "left"
1637 Generally, it moves the cursor to the next beginning of a word on the left.
1638 However, in Bidi text this become slightly more complicated, and there
1639 are different modes of cursor movement.
1640 In "visual mode", this moves left, plain and simple.
1641 In "logical mode", movement is logically forward in RTL paragraphs, and
1642 logically backwards in LTR paragraphs.
1645 \begin_layout Description
1649 \begin_layout Description
1650 Origin dov, 28 Oct 2007
1653 \begin_layout Subsection*
1654 LFUN_WORD_LEFT_SELECT
1657 \begin_layout Description
1658 Action Moves the cursor to the next beginning of a word "on the left", adding
1659 *logically* traversed text to the selection.
1662 \begin_layout Description
1663 Notion See also LFUN_WORD_LEFT for exact details of the movement.
1666 \begin_layout Description
1667 Syntax word-left-select
1670 \begin_layout Description
1671 Origin dov, 28 Oct 2007
1674 \begin_layout Subsection*
1678 \begin_layout Description
1679 Action Moves the cursor to the next beginning of a word "on the right".
1682 \begin_layout Description
1683 Notion This is the action which should be taken when the (e.g., ctrl-) "right"
1685 Generally, it moves the cursor to the next beginning of a word on the right.
1686 However, in Bidi text this become slightly more complicated, and there
1687 are different modes of cursor movement.
1688 In "visual mode", this moves right, plain and simple.
1689 In "logical mode", movement is logically forward in LTR paragraphs, and
1690 logically backwards in RTL paragraphs.
1693 \begin_layout Description
1697 \begin_layout Description
1698 Origin dov, 28 Oct 2007
1701 \begin_layout Subsection*
1702 LFUN_WORD_RIGHT_SELECT
1705 \begin_layout Description
1706 Action Moves the cursor to the next beginning of a word "on the right",
1707 adding *logically* traversed text to the selection.
1710 \begin_layout Description
1711 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
1714 \begin_layout Description
1715 Syntax word-right-select
1718 \begin_layout Description
1719 Origin dov, 28 Oct 2007
1722 \begin_layout Subsection*
1726 \begin_layout Description
1727 Action Puts the word where the cursor stands into the selection.
1730 \begin_layout Description
1734 \begin_layout Description
1735 Origin Andre, 11 Sep 2002
1738 \begin_layout Subsection*
1739 LFUN_WORD_CAPITALIZE
1742 \begin_layout Description
1743 Action Capitalizes the words in the selection (i.e.
1744 the first letters) or the letter on the cursor position.
1747 \begin_layout Description
1748 Syntax word-capitalize
1751 \begin_layout Subsection*
1755 \begin_layout Description
1756 Action Change the words in the selection or from the cursor position to
1757 the end of word to the upper case.
1760 \begin_layout Description
1764 \begin_layout Subsection*
1768 \begin_layout Description
1769 Action Change the words in the selection or from the cursor position to
1770 the end of word to the lower case.
1773 \begin_layout Description
1777 \begin_layout Subsection*
1781 \begin_layout Description
1782 Action Add the word under the cursor to the respective spell checker dictionary.
1785 \begin_layout Description
1786 Syntax spelling-add [<STRING>] [<LANG>]
1789 \begin_layout Description
1790 Params <WORD>: word to add <LANG>: language name (see file languages)
1793 \begin_layout Description
1794 Origin JSpitzm, 18 Jan 2010
1797 \begin_layout Subsection*
1798 LFUN_SPELLING_IGNORE
1801 \begin_layout Description
1802 Action Let the spell checker ignore the word under the cursor in the current
1803 session for the given language.
1806 \begin_layout Description
1807 Syntax spelling-ignore [<WORD>] [<LANG>]
1810 \begin_layout Description
1811 Params <WORD>: word to ignore <LANG>: language name (see file languages)
1814 \begin_layout Description
1815 Origin JSpitzm, 18 Jan 2010
1818 \begin_layout Subsection*
1819 LFUN_SPELLING_REMOVE
1822 \begin_layout Description
1823 Action Remove the word under the cursor from the respective spell checker
1827 \begin_layout Description
1828 Syntax spelling-remove [<STRING>] [<LANG>]
1831 \begin_layout Description
1832 Params <WORD>: word to remove <LANG>: language name (see file languages)
1835 \begin_layout Description
1836 Origin SWitt, 28 July 2010
1839 \begin_layout Subsection*
1840 LFUN_THESAURUS_ENTRY
1843 \begin_layout Description
1844 Action Look up thesaurus entries with respect to the word under the cursor.
1847 \begin_layout Description
1848 Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
1851 \begin_layout Description
1852 Params <STRING>: word to look up <LANG>: language (see file languages)
1855 \begin_layout Description
1856 Origin Levon, 20 Jul 2001
1859 \begin_layout Subsection*
1863 \begin_layout Description
1864 Action Move the cursor to the beginning of the document.
1867 \begin_layout Description
1871 \begin_layout Subsection*
1872 LFUN_BUFFER_BEGIN_SELECT
1875 \begin_layout Description
1876 Action Move the cursor to the beginning of the document adding the traversed
1877 text to the selection.
1880 \begin_layout Description
1881 Syntax buffer-begin-select
1884 \begin_layout Subsection*
1888 \begin_layout Description
1889 Action Move the cursor to the end of the document.
1892 \begin_layout Description
1896 \begin_layout Subsection*
1897 LFUN_BUFFER_END_SELECT
1900 \begin_layout Description
1901 Action Move the cursor to the end of the document adding the traversed text
1905 \begin_layout Description
1906 Syntax buffer-end-select
1909 \begin_layout Subsection*
1913 \begin_layout Description
1914 Action Move the cursor to the beginning of the current inset if it is not
1915 already there, or at the beginning of the enclosing inset otherwise
1918 \begin_layout Description
1922 \begin_layout Description
1923 Origin lasgouttes, 16 Mar 2009
1926 \begin_layout Subsection*
1927 LFUN_INSET_BEGIN_SELECT
1930 \begin_layout Description
1931 Action Move the cursor to the beginning of the current inset if it is not
1932 already there, or at the beginning of the enclosing inset otherwise (adding
1933 the traversed text to the selection).
1936 \begin_layout Description
1937 Syntax inset-begin-select
1940 \begin_layout Description
1941 Origin lasgouttes, 16 Mar 2009
1944 \begin_layout Subsection*
1948 \begin_layout Description
1949 Action Move the cursor to the end of the current inset if it is not already
1950 there, or at the end of the enclosing inset otherwise
1953 \begin_layout Description
1957 \begin_layout Description
1958 Origin lasgouttes, 16 Mar 2009
1961 \begin_layout Subsection*
1962 LFUN_INSET_END_SELECT
1965 \begin_layout Description
1966 Action Move the cursor to the end of the current inset if it is not already
1967 there, or at the end of the enclosing inset otherwise (adding the traversed
1968 text to the selection).
1971 \begin_layout Description
1972 Syntax inset-end-select
1975 \begin_layout Description
1976 Origin lasgouttes, 16 Mar 2009
1979 \begin_layout Subsection*
1980 LFUN_INSET_SELECT_ALL
1983 \begin_layout Description
1984 Action Selects all contents of an inset.
1987 \begin_layout Description
1988 Syntax inset-select-all
1991 \begin_layout Description
1992 Origin vfr, 22 Aug 2009
1995 \begin_layout Subsection*
1999 \begin_layout Description
2000 Action Selects the whole section.
2003 \begin_layout Description
2004 Notion The cursor should be in a section heading before calling this lfun.
2007 \begin_layout Description
2008 Syntax section-select
2011 \begin_layout Description
2012 Origin vfr, 05 May 2009
2015 \begin_layout Subsection*
2019 \begin_layout Description
2020 Action Move the cursor to the begining of the (screen) line.
2023 \begin_layout Description
2027 \begin_layout Subsection*
2028 LFUN_LINE_BEGIN_SELECT
2031 \begin_layout Description
2032 Action Move the cursor to the beginning of the (screen) line adding the
2033 traversed text to the selection.
2036 \begin_layout Description
2037 Syntax line-begin-select
2040 \begin_layout Subsection*
2044 \begin_layout Description
2045 Action Move the cursor to the end of the (screen) line.
2048 \begin_layout Description
2052 \begin_layout Subsection*
2053 LFUN_LINE_END_SELECT
2056 \begin_layout Description
2057 Action Move the cursor to the end of the (screen) line adding the traversed
2058 text to the selection.
2061 \begin_layout Description
2062 Syntax line-end-select
2065 \begin_layout Subsection*
2069 \begin_layout Description
2070 Action Deletes the letters to the end of the (screen) line or deletes the
2074 \begin_layout Description
2075 Syntax line-delete-forward
2078 \begin_layout Subsection*
2082 \begin_layout Description
2083 Action Copies to the clipboard the last edit.
2086 \begin_layout Description
2090 \begin_layout Subsection*
2094 \begin_layout Description
2095 Action Cuts to the clipboard.
2098 \begin_layout Description
2102 \begin_layout Subsection*
2106 \begin_layout Description
2107 Action Pastes material (text or picture) from the active clipboard.
2110 \begin_layout Description
2111 Syntax paste [<TYPE>|<NUM>]
2114 \begin_layout Description
2115 Params <TYPE>: emf|pdf|png|jpeg|linkback|wmf
2116 \begin_inset Newline newline
2119 <NUM>: number of the selection in the internal clipboard stack to be pasted.
2122 \begin_layout Subsection*
2123 LFUN_CLIPBOARD_PASTE
2126 \begin_layout Description
2127 Action Pastes text from the active clipboard.
2130 \begin_layout Description
2131 Syntax clipboard-paste [<ARG>]
2134 \begin_layout Description
2135 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
2139 \begin_layout Description
2140 Origin Georg, 10 Jul 2006
2143 \begin_layout Subsection*
2144 LFUN_PRIMARY_SELECTION_PASTE
2147 \begin_layout Description
2148 Action Pastes the currently selected text.
2151 \begin_layout Description
2152 Notion Primary selection mechanism is linux-only thing.
2155 \begin_layout Description
2156 Syntax primary-selection-paste [<ARG>]
2159 \begin_layout Description
2160 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
2164 \begin_layout Subsection*
2165 LFUN_SELECTION_PASTE
2168 \begin_layout Description
2169 Action Pastes the the internal selection text in permanent selection.
2172 \begin_layout Description
2173 Notion Created in order to have middle mouse button pasting correct (bound
2174 to command-alternatives selection-paste ; primary-selection-paste paragraph).
2177 \begin_layout Description
2178 Syntax selection-paste
2181 \begin_layout Description
2182 Origin lasgouttes, 14 Jan 2009
2185 \begin_layout Subsection*
2189 \begin_layout Description
2190 Action Undoes the last edit.
2193 \begin_layout Description
2197 \begin_layout Subsection*
2201 \begin_layout Description
2202 Action Redoes the last thing undone.
2205 \begin_layout Description
2209 \begin_layout Subsection*
2213 \begin_layout Description
2214 Action Repeat the given command.
2217 \begin_layout Description
2218 Syntax repeat <COUNT> <LFUN-COMMAND>
2221 \begin_layout Description
2222 Origin Andre, 27 Oct 2003
2225 \begin_layout Subsection*
2226 LFUN_CHARS_TRANSPOSE
2229 \begin_layout Description
2230 Action Transposes the character at the cursor with the one before it.
2233 \begin_layout Description
2234 Syntax chars-transpose
2237 \begin_layout Description
2238 Origin Lgb, 25 Apr 2001
2241 \begin_layout Subsection*
2242 LFUN_DEPTH_DECREMENT
2245 \begin_layout Description
2246 Action Decrease the nesting depth of the (selected) paragraph(s) inside
2250 \begin_layout Description
2251 Syntax depth-decrement
2254 \begin_layout Subsection*
2255 LFUN_DEPTH_INCREMENT
2258 \begin_layout Description
2259 Action Increase the nesting depth of the (selected) paragraph(s) inside
2263 \begin_layout Description
2264 Syntax depth-increment
2267 \begin_layout Subsection*
2271 \begin_layout Description
2272 Action Toggles the bold font (selection-wise) using mathbf in math.
2275 \begin_layout Description
2279 \begin_layout Subsection*
2280 LFUN_FONT_BOLDSYMBOL
2283 \begin_layout Description
2284 Action Toggles the bold font (selection-wise) using boldsymbol in math.
2287 \begin_layout Description
2288 Syntax font-boldsymbol
2291 \begin_layout Subsection*
2292 LFUN_FONT_TYPEWRITER
2295 \begin_layout Description
2296 Action Toggles the typewriter family font (selection-wise).
2299 \begin_layout Description
2300 Syntax font-typewriter
2303 \begin_layout Subsection*
2307 \begin_layout Description
2308 Action Toggles underline in the font (selection-wise).
2311 \begin_layout Description
2312 Syntax font-underline
2315 \begin_layout Subsection*
2319 \begin_layout Description
2320 Action Toggles double underline in the font (selection-wise).
2323 \begin_layout Description
2324 Syntax font-underunderline
2327 \begin_layout Description
2328 Origin sanda, 5 May 2009
2331 \begin_layout Subsection*
2335 \begin_layout Description
2336 Action Toggles wavy underline in the font (selection-wise).
2339 \begin_layout Description
2340 Syntax font-underwave
2343 \begin_layout Description
2344 Origin sanda, 5 May 2009
2347 \begin_layout Subsection*
2351 \begin_layout Description
2352 Action Toggles strikeout (strike-through) in the font (selection-wise).
2355 \begin_layout Description
2356 Syntax font-strikeout
2359 \begin_layout Description
2360 Origin sanda, 3 May 2009
2363 \begin_layout Subsection*
2367 \begin_layout Description
2368 Action Toggles the emphasis font style (selection-wise).
2371 \begin_layout Description
2375 \begin_layout Subsection*
2379 \begin_layout Description
2380 Action Toggles Noun text style font (selection-wise).
2383 \begin_layout Description
2387 \begin_layout Subsection*
2391 \begin_layout Description
2392 Action Toggles Roman family font (selection-wise).
2395 \begin_layout Description
2399 \begin_layout Subsection*
2403 \begin_layout Description
2404 Action Toggles Sans Serif family font (selection-wise).
2407 \begin_layout Description
2411 \begin_layout Subsection*
2415 \begin_layout Description
2416 Action Toggles Fraktur family font (math-mode, selection-wise).
2419 \begin_layout Description
2423 \begin_layout Description
2424 Origin vermeer, 10 Jan 2002
2427 \begin_layout Subsection*
2431 \begin_layout Description
2432 Action Toggles Italics font shape (math-mode, selection-wise).
2435 \begin_layout Description
2439 \begin_layout Description
2440 Origin vermeer, 10 Jan 2002
2443 \begin_layout Subsection*
2447 \begin_layout Description
2448 Action Reverts the settings of the font to the default values (selection-wise).
2451 \begin_layout Description
2455 \begin_layout Subsection*
2459 \begin_layout Description
2460 Action Sets font size according to lyx format string.
2463 \begin_layout Description
2464 Syntax font-size <SIZE>
2467 \begin_layout Description
2468 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
2469 \begin_inset Newline newline
2472 largest|huge|giant|increase|decrease|default
2475 \begin_layout Subsection*
2476 LFUN_TEXTSTYLE_APPLY
2479 \begin_layout Description
2480 Action Toggle user-defined (=last-time used) text style.
2483 \begin_layout Description
2484 Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically
2485 trigerred when using Text Style dialog.
2488 \begin_layout Description
2489 Syntax textstyle-apply
2492 \begin_layout Description
2493 Origin leeming, 12 Mar 2003
2496 \begin_layout Subsection*
2497 LFUN_TEXTSTYLE_UPDATE
2500 \begin_layout Description
2501 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APP
2505 \begin_layout Description
2506 Syntax textstyle-update <FONT_INFO>
2509 \begin_layout Description
2510 Params <FONT_INFO>: specifies font atributes, e.g.
2511 family, series, shape, size, emph, noun, underbar, number, color, language,
2513 \begin_inset Newline newline
2516 Use lyx -dbg action for exact syntax of text-style dialog parameters.
2519 \begin_layout Description
2520 Origin leeming, 12 Mar 2003
2523 \begin_layout Subsection*
2524 LFUN_SCREEN_FONT_UPDATE
2527 \begin_layout Description
2528 Action Update fonts and its metrics.
2531 \begin_layout Description
2532 Notion Automatically called after zoom, dpi, font names, or norm change.
2535 \begin_layout Description
2536 Syntax screen-font-update
2539 \begin_layout Description
2540 Origin ARRae, 13 Aug 2000
2543 \begin_layout Subsection*
2547 \begin_layout Description
2548 Action Returns the info about the current font.
2551 \begin_layout Description
2555 \begin_layout Subsection*
2556 LFUN_CITATION_INSERT
2559 \begin_layout Description
2560 Action Inserts citation from loaded citation database.
2563 \begin_layout Description
2564 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
2567 \begin_layout Description
2568 Params <KEY>: Citation (shortcut listed in available citations).
2569 \begin_inset Newline newline
2572 <TEXT_BEFORE>: text which should appear before citation.
2575 \begin_layout Description
2576 Origin AAS, 97-02-23
2579 \begin_layout Subsection*
2580 LFUN_BIBTEX_DATABASE_ADD
2583 \begin_layout Description
2584 Action Adds database, which will be used for bibtex citations.
2587 \begin_layout Description
2588 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX
2589 bibliography) found from the cursor postion.
2592 \begin_layout Description
2593 Syntax bibtex-database-add <DATABASE-NAME>
2596 \begin_layout Description
2597 Origin Ale, 30 May 1997
2600 \begin_layout Subsection*
2601 LFUN_BIBTEX_DATABASE_DEL
2604 \begin_layout Description
2605 Action Adds database, which will be used for bibtex citations.
2608 \begin_layout Description
2609 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTe
2610 X bibliography) found from the cursor postion.
2613 \begin_layout Description
2614 Syntax bibtex-database-del <DATABASE-NAME>
2617 \begin_layout Description
2618 Origin Ale, 30 May 1997
2621 \begin_layout Subsection*
2625 \begin_layout Description
2626 Action Sets the layout (that is, environment) for the current paragraph.
2629 \begin_layout Description
2630 Syntax layout <LAYOUT>
2633 \begin_layout Description
2634 Params <LAYOUT>: the layout to use
2637 \begin_layout Subsection*
2638 LFUN_LAYOUT_PARAGRAPH
2641 \begin_layout Description
2642 Action Launches the paragraph settings dialog.
2645 \begin_layout Description
2646 Syntax layout-paragraph
2649 \begin_layout Subsection*
2653 \begin_layout Description
2654 Action Launches the tabular settings dialog.
2657 \begin_layout Description
2658 Syntax layout-tabular
2661 \begin_layout Description
2662 Origin Jug, 31 Jul 2000
2665 \begin_layout Subsection*
2666 LFUN_DROP_LAYOUTS_CHOICE
2669 \begin_layout Description
2670 Action Displays list of layout choices.
2673 \begin_layout Description
2674 Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox
2675 allowing for choice of layout.
2678 \begin_layout Description
2679 Syntax drop-layouts-choice
2682 \begin_layout Subsection*
2683 LFUN_LAYOUT_MODULES_CLEAR
2686 \begin_layout Description
2687 Action Clears the module list.
2690 \begin_layout Description
2691 Notion Clears the list of included modules for the current buffer.
2694 \begin_layout Description
2695 Syntax layout-modules-clear
2698 \begin_layout Description
2699 Origin rgh, 25 August 2007
2702 \begin_layout Subsection*
2703 LFUN_LAYOUT_MODULE_ADD
2706 \begin_layout Description
2707 Action Adds a module.
2710 \begin_layout Description
2711 Notion Adds a module to the list of included modules for the current buffer.
2714 \begin_layout Description
2715 Syntax layout-module-add <MODULE>
2718 \begin_layout Description
2719 Params <MODULE>: the module to be added
2722 \begin_layout Description
2723 Origin rgh, 25 August 2007
2726 \begin_layout Subsection*
2730 \begin_layout Description
2731 Action Reloads layout information.
2734 \begin_layout Description
2735 Notion Reloads all layout information for the current buffer from disk,
2736 thus recognizing any changes that have been made to layout files on the
2738 This is intended to be used only by layout developers and should not be
2739 used when one is trying to do actual work.
2742 \begin_layout Description
2743 Syntax layout-reload
2746 \begin_layout Description
2747 Origin rgh, 3 September 2007
2750 \begin_layout Subsection*
2751 LFUN_TEXTCLASS_APPLY
2754 \begin_layout Description
2755 Action Sets the text class for the current buffer.
2758 \begin_layout Description
2759 Syntax textclass-apply <TEXTCLASS>
2762 \begin_layout Description
2763 Params <TEXTCLASS>: the textclass to set.
2764 Note that this must be the filename, minus the ".layout" extension.
2767 \begin_layout Subsection*
2771 \begin_layout Description
2772 Action Loads information for a textclass from disk.
2775 \begin_layout Description
2776 Syntax textclass-load <TEXTCLASS>
2779 \begin_layout Description
2780 Params <TEXTCLASS>: the textclass to load.
2781 Note that this must be the filename, minus the ".layout" extension.
2784 \begin_layout Subsection*
2788 \begin_layout Description
2789 Action Disable selecting of text-region.
2792 \begin_layout Description
2796 \begin_layout Subsection*
2800 \begin_layout Description
2801 Action Enable selecting of text-region.
2804 \begin_layout Description
2805 Notion After enabling you can simply move arrow keys to get selected region.
2808 \begin_layout Description
2812 \begin_layout Subsection*
2816 \begin_layout Description
2817 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
2820 \begin_layout Description
2824 \begin_layout Description
2825 Origin Andre, May 5 2006
2828 \begin_layout Subsection*
2832 \begin_layout Description
2833 Action Inserts math delimiters (e.g.
2834 parentheses, brackets) enclosing expression.
2837 \begin_layout Description
2838 Syntax math-delim [<LEFT>] [<RIGHT>]
2841 \begin_layout Description
2842 Params <LEFT/RIGHT>: Delimiters to be used.
2843 Each delimiter can be specified by either a LaTeX name or a valid character.
2844 ( is the default letter.
2847 \begin_layout Description
2848 Sample math-delim { rangle
2851 \begin_layout Description
2852 Origin Alejandro, 18 Jun 1996
2855 \begin_layout Subsection*
2859 \begin_layout Description
2860 Action Inserts math fixed size delimiters (e.g.
2861 parentheses, brackets) enclosing expression.
2864 \begin_layout Description
2865 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
2868 \begin_layout Description
2869 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
2870 \begin_inset Newline newline
2873 <L/RDELIM>: TeX code for delimiter.
2874 See Delimiter dialog for delimiters to be used.
2877 \begin_layout Description
2878 Sample math-bigdelim "Bigl" "
2885 \begin_layout Description
2886 Origin Enrico & Georg, 7 May 2006
2889 \begin_layout Subsection*
2893 \begin_layout Description
2894 Action Creates a new displayed equation in text mode.
2895 Toggles inlined/display formula in math mode.
2898 \begin_layout Description
2899 Syntax math-display [<ARG>]
2902 \begin_layout Description
2903 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating
2904 new equation from the text mode.
2907 \begin_layout Description
2908 Origin Alejandro, 18 Jun 1996
2911 \begin_layout Subsection*
2915 \begin_layout Description
2916 Action Inserts math objects and symbols.
2919 \begin_layout Description
2920 Notion When <ARG> is a _single_ math inset with more than one cell (such
2923 frac{x}{y}"), the content of cell(0) is replaced by the current selection
2924 (only works if the selection is in mathed).
2925 As an example, if "abc" is selected in mathed, "math-insert
2927 frac{x}{y}" replaces "abc" with "
2929 frac{abc}{y}", and "math-insert x_y^z" replaces "abc" with "abc_y^z".
2930 If nothing is selected (or the selection is not in mathed), math-insert
2934 \begin_layout Description
2935 Syntax math-insert <ARG>
2938 \begin_layout Description
2939 Params <ARG>: Symbol or LaTeX code to be inserted.
2942 \begin_layout Subsection*
2946 \begin_layout Description
2947 Action Enters subscript expression in math expression.
2950 \begin_layout Description
2951 Syntax math-subscript
2954 \begin_layout Description
2955 Origin vermeer, 12 Dec 2001
2958 \begin_layout Subsection*
2959 LFUN_MATH_SUPERSCRIPT
2962 \begin_layout Description
2963 Action Enters superscript expression in math expression.
2966 \begin_layout Description
2967 Syntax math-superscript
2970 \begin_layout Description
2971 Origin vermeer, 12 Dec 2001
2974 \begin_layout Subsection*
2978 \begin_layout Description
2979 Action Toggles the position of the limits from above/below to the right
2980 side an vice versa in integral symbol, a limit, a summation, etc.
2983 \begin_layout Description
2984 Notion Put the cursor before the symbol with the limits and then invoke
2988 \begin_layout Description
2989 Syntax math-limits [<STATE>]
2992 \begin_layout Description
2993 Params <STATE>: limits|nolimits
2996 \begin_layout Subsection*
3000 \begin_layout Description
3001 Action Inserts a math macro definition at the cursor position in the text.
3004 \begin_layout Description
3005 Syntax math-macro <NAME> [<NARGS>] [def]
3008 \begin_layout Description
3009 Params <NAME>: The name of the macro, e.g.
3011 \begin_inset Newline newline
3014 <NARGS>: The number of parameters of the macro.
3016 "def": Has no effect anymore, just for compatibility with former LyX versions.
3019 \begin_layout Description
3020 Origin ale, 10 May 1997; sts, 21 Dec 2007
3023 \begin_layout Subsection*
3027 \begin_layout Description
3028 Action Mutates the type of math inset to the newly selected one.
3031 \begin_layout Description
3032 Syntax math-mutate <TYPE>
3035 \begin_layout Description
3036 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
3037 multline|gather|flalign
3040 \begin_layout Description
3041 Origin Andre, 23 May 2001
3044 \begin_layout Subsection*
3048 \begin_layout Description
3049 Action Inserts space into math expression.
3052 \begin_layout Description
3053 Notion Use spacebar after entering this space to change type of space.
3056 \begin_layout Description
3057 Syntax math-space [<TYPE>] [<LEN>]
3060 \begin_layout Description
3061 Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
3062 \begin_inset Newline newline
3065 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
3066 \begin_inset Newline newline
3069 custom space: hspace
3070 \begin_inset Newline newline
3073 "," used by default.
3074 \begin_inset Newline newline
3077 Note that ! is equivalent to negthinspace, , = thinspace, : = medspace,
3079 \begin_inset Newline newline
3082 <LEN>: length for custom spaces (hspace)
3085 \begin_layout Description
3086 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
3089 \begin_layout Subsection*
3093 \begin_layout Description
3094 Action Inserts a matrix.
3097 \begin_layout Description
3098 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
3101 \begin_layout Description
3102 Params <ALIGN>: Alignment is a word composed of the vertical alignment (b,
3104 1 char) and the horizontal alignments (l, c or r) (i.e.
3108 \begin_layout Description
3109 Sample math-matrix 3 3 bccc
3112 \begin_layout Subsection*
3113 LFUN_MATH_AMS_MATRIX
3116 \begin_layout Description
3117 Action Inserts a matrix.
3120 \begin_layout Description
3121 Syntax math-matrix <COLS> <ROWS> [<DECORATION>]
3124 \begin_layout Description
3125 Params <DECORATION>: Decoration determines the LaTeX name of the matrix
3126 that should be created.
3129 \begin_layout Description
3130 Sample math-ams-matrix 3 3 bmatrix
3133 \begin_layout Subsection*
3137 \begin_layout Description
3138 Action In text mode enters math mode (i.e.
3139 puts math insets on the current cursor position), in math mode enters text
3140 mode inside math expression.
3143 \begin_layout Description
3144 Notion If there is some selected text, it puts the text inside created math
3148 \begin_layout Description
3149 Syntax math-mode [on|<ARG>]
3152 \begin_layout Description
3153 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT
3155 \begin_inset Newline newline
3158 "on": allow only entering of math mode from text mode.
3161 \begin_layout Description
3162 Origin Alejandro, 4 Jun 1996
3165 \begin_layout Subsection*
3169 \begin_layout Description
3170 Action Enters regexp mode (i.e., puts regexp insets on the current cursor
3172 Used by the advanced search dialog.
3175 \begin_layout Description
3176 Notion If there is any selected text, then it is moved inside the created
3180 \begin_layout Description
3181 Syntax regexp-mode [<ARG>]
3184 \begin_layout Description
3185 Params <ARG>: eventual argument (regular expression).
3188 \begin_layout Description
3189 Origin Tommaso, 4 Oct 2008
3192 \begin_layout Subsection*
3193 LFUN_MATH_NUMBER_LINE_TOGGLE
3196 \begin_layout Description
3197 Action Toggles numbering of the current formula line.
3200 \begin_layout Description
3201 Notion Must be in display formula mode.
3204 \begin_layout Description
3205 Syntax math-number-line-toggle
3208 \begin_layout Description
3209 Origin Alejandro, 18 Jun 1996
3212 \begin_layout Subsection*
3213 LFUN_MATH_NUMBER_TOGGLE
3216 \begin_layout Description
3217 Action Toggles numbering/labeling of the current formula.
3220 \begin_layout Description
3221 Notion Must be in display formula mode.
3224 \begin_layout Description
3225 Syntax math-number-toggle
3228 \begin_layout Description
3229 Origin Alejandro, 4 Jun 1996
3232 \begin_layout Subsection*
3236 \begin_layout Description
3237 Action Calls external program and passes the current expression/equation
3238 as an argument for the calculation in the format appropriate to the given
3242 \begin_layout Description
3243 Notion Selection can be used to determine the input for the external program.
3246 \begin_layout Description
3247 Syntax math-extern <LANG> [<COMMAND>]
3250 \begin_layout Description
3251 Params <LANG>: octave|maxima|maple|mathematica|script
3252 \begin_inset Newline newline
3255 where "script" stands fot the external script (normalized expression will
3259 \begin_layout Description
3260 Sample math-extern maple simplify
3263 \begin_layout Description
3264 Origin Andre, 24 Apr 2001
3267 \begin_layout Subsection*
3271 \begin_layout Description
3272 Action Changes arbitrarily the size used by math fonts inside a context.
3275 \begin_layout Description
3276 Notion Provides an interface to the LaTeX math mode font size commands.
3279 \begin_layout Description
3280 Syntax math-size <STYLE>
3283 \begin_layout Description
3295 \begin_layout Description
3296 Origin Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
3299 \begin_layout Subsection*
3300 LFUN_MATH_FONT_STYLE
3303 \begin_layout Description
3304 Action Changes the text style used in math.
3307 \begin_layout Description
3308 Syntax math-font-style <STYLE>
3311 \begin_layout Description
3312 Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal
3313 \begin_inset Newline newline
3316 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
3319 \begin_layout Description
3320 Origin vfr, 9 jan 2009
3323 \begin_layout Subsection*
3324 LFUN_MATH_MACRO_UNFOLD
3327 \begin_layout Description
3328 Action Unfold a Math Macro.
3331 \begin_layout Description
3332 Notion Unfold the Math Macro the cursor is in, i.e.
3338 \begin_layout Description
3339 Syntax math-macro-unfold
3342 \begin_layout Description
3343 Origin sts, 06 January 2008
3346 \begin_layout Subsection*
3347 LFUN_MATH_MACRO_FOLD
3350 \begin_layout Description
3351 Action Fold a Math Macro.
3354 \begin_layout Description
3355 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e.
3361 \begin_layout Description
3362 Syntax math-macro-fold
3365 \begin_layout Description
3366 Origin sts, 06 January 2008
3369 \begin_layout Subsection*
3370 LFUN_MATH_MACRO_ADD_PARAM
3373 \begin_layout Description
3374 Action Add a parameter.
3377 \begin_layout Description
3378 Notion Add a parameter to a Math Macro.
3381 \begin_layout Description
3382 Syntax math-macro-add-param <NUM>
3385 \begin_layout Description
3386 Params <NUM>: The number of the parameter behind which the new one will
3387 be added (1 for the first, i.e.
3388 use 0 for add a parameter at the left), defaults to the last one.
3391 \begin_layout Description
3392 Origin sts, 06 January 2008
3395 \begin_layout Subsection*
3396 LFUN_MATH_MACRO_REMOVE_PARAM
3399 \begin_layout Description
3400 Action Remove the last parameter.
3403 \begin_layout Description
3404 Notion Remove the last parameter of a Math Macro and remove its value in
3405 all instances of the macro in the buffer.
3408 \begin_layout Description
3409 Syntax math-macro-remove-param <NUM>
3412 \begin_layout Description
3413 Params <NUM>: The number of the parameter to be deleted (1 for the first),
3414 defaults to the last one.
3417 \begin_layout Description
3418 Origin sts, 06 January 2008
3421 \begin_layout Subsection*
3422 LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
3425 \begin_layout Description
3426 Action Append a greedy parameter.
3429 \begin_layout Description
3430 Notion Append a greedy parameter to a Math Macro which eats the following
3431 mathed cell in every instance of the macro in the buffer.
3434 \begin_layout Description
3435 Syntax math-macro-append-greedy-param
3438 \begin_layout Description
3439 Origin sts, 06 January 2008
3442 \begin_layout Subsection*
3443 LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
3446 \begin_layout Description
3447 Action Remove a greedy parameter.
3450 \begin_layout Description
3451 Notion Remove a greedy parameter of a Math Macro and spit out the values
3452 of it in every instance of the macro in the buffer.
3453 If it is an optional parameter the [valud] format is used.
3456 \begin_layout Description
3457 Syntax math-macro-remove-greedy-param
3460 \begin_layout Description
3461 Origin sts, 06 January 2008
3464 \begin_layout Subsection*
3465 LFUN_MATH_MACRO_MAKE_OPTIONAL
3468 \begin_layout Description
3469 Action Make a parameter optional.
3472 \begin_layout Description
3473 Notion Turn the first non-optional parameter of a Math Macro into an optional
3474 parameter with a default value.
3477 \begin_layout Description
3478 Syntax math-macro-make-optional
3481 \begin_layout Description
3482 Origin sts, 06 January 2008
3485 \begin_layout Subsection*
3486 LFUN_MATH_MACRO_MAKE_NONOPTIONAL
3489 \begin_layout Description
3490 Action Make a parameter non-optional.
3493 \begin_layout Description
3494 Notion Turn the last optional parameter of a Math Macro into a non-optional
3496 The default value is remembered to be reused later if the user changes
3500 \begin_layout Description
3501 Syntax math-macro-make-nonoptional
3504 \begin_layout Description
3505 Origin sts, 06 January 2008
3508 \begin_layout Subsection*
3509 LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
3512 \begin_layout Description
3513 Action Add an optional parameter.
3516 \begin_layout Description
3517 Notion Insert an optional parameter just behind the already existing optional
3521 \begin_layout Description
3522 Syntax math-macro-add-optional-param
3525 \begin_layout Description
3526 Origin sts, 06 January 2008
3529 \begin_layout Subsection*
3530 LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
3533 \begin_layout Description
3534 Action Remove the last optional parameter.
3537 \begin_layout Description
3538 Notion Remove the last optional parameter of a Math Macro and remove it
3539 in all the instances of the macro in the buffer.
3542 \begin_layout Description
3543 Syntax math-macro-remove-optional-param
3546 \begin_layout Description
3547 Origin sts, 06 January 2008
3550 \begin_layout Subsection*
3551 LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
3554 \begin_layout Description
3555 Action Add a greedy optional parameter.
3558 \begin_layout Description
3559 Notion Add a greedy optional parameter which eats the value from the following
3560 cells in mathed which are in the [value] format.
3563 \begin_layout Description
3564 Syntax math-macro-add-greedy-optional-param
3567 \begin_layout Description
3568 Origin sts, 06 January 2008
3571 \begin_layout Subsection*
3572 LFUN_IN_MATHMACROTEMPLATE
3575 \begin_layout Description
3576 Action Only active in Math Macro definition.
3579 \begin_layout Description
3580 Notion Dummy function which is only active in a Math Macro definition.
3581 It's used to toggle the Math Macro toolbar if the cursor moves into a Math
3585 \begin_layout Description
3586 Syntax in-mathmacrotemplate
3589 \begin_layout Description
3590 Origin sts, 06 January 2008
3593 \begin_layout Subsection*
3594 LFUN_PARAGRAPH_MOVE_DOWN
3597 \begin_layout Description
3598 Action Moves the current paragraph downwards in the document.
3601 \begin_layout Description
3602 Syntax paragraph-move-down
3605 \begin_layout Description
3606 Origin Edwin, 8 Apr 2006
3609 \begin_layout Subsection*
3610 LFUN_PARAGRAPH_MOVE_UP
3613 \begin_layout Description
3614 Action Moves the current paragraph upwards in the document.
3617 \begin_layout Description
3618 Syntax paragraph-move-up
3621 \begin_layout Description
3622 Origin Edwin, 8 Apr 2006
3625 \begin_layout Subsection*
3629 \begin_layout Description
3630 Action Move the cursor to the next paragraph (or begining of the current
3631 one) in upward direction.
3634 \begin_layout Description
3638 \begin_layout Description
3639 Origin Asger, 1 Oct 1996
3642 \begin_layout Subsection*
3643 LFUN_PARAGRAPH_UP_SELECT
3646 \begin_layout Description
3647 Action Move the cursor and select the text to the next paragraph (or begining
3648 of the current one) in upward direction.
3651 \begin_layout Description
3652 Syntax paragraph-up-select
3655 \begin_layout Description
3656 Origin Asger, 1 Oct 1996
3659 \begin_layout Subsection*
3663 \begin_layout Description
3664 Action Move the cursor to the next paragraph (or begining of the current
3665 one) in downward direction.
3668 \begin_layout Description
3669 Syntax paragraph-down
3672 \begin_layout Description
3673 Origin Asger, 1 Oct 1996
3676 \begin_layout Subsection*
3677 LFUN_PARAGRAPH_DOWN_SELECT
3680 \begin_layout Description
3681 Action Move the cursor and select the text to the next paragraph (or begining
3682 of the current one) in downward direction.
3685 \begin_layout Description
3686 Syntax paragraph-down-select
3689 \begin_layout Description
3690 Origin Asger, 1 Oct 1996
3693 \begin_layout Subsection*
3697 \begin_layout Description
3698 Action Jump to a paragraph given by its id number and optionally the desired
3699 position within the paragraph.
3702 \begin_layout Description
3703 Notion Note that id number of paragraph is not the sequential number of
3704 paragraph seen on the screen.
3705 Moreover the id is unique for all opened buffers (documents).
3708 \begin_layout Description
3709 Syntax paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
3712 \begin_layout Description
3713 Params <PAR_ID_NUMBER>: paragraph id
3714 \begin_inset Newline newline
3717 <POSITION_IN_PAR>: desired position within the paragraph
3720 \begin_layout Description
3721 Origin Dekel, 26 Aug 2000
3724 \begin_layout Subsection*
3725 LFUN_BREAK_PARAGRAPH
3728 \begin_layout Description
3729 Action Breaks the current paragraph at the current location.
3732 \begin_layout Description
3733 Notion Removes the selection.
3736 \begin_layout Description
3737 Syntax break-paragraph [<LAYOUT>]
3740 \begin_layout Description
3741 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to
3742 default layout) when the cursor is at the end of the line.
3745 \begin_layout Subsection*
3746 LFUN_PARAGRAPH_PARAMS
3749 \begin_layout Description
3750 Action Change paragraph settings.
3753 \begin_layout Description
3754 Notion Modifies the current paragraph, or currently selected paragraphs.
3755 This function only modifies, and does not override, existing settings.
3756 Note that the "leftindent" indent setting is deprecated.
3759 \begin_layout Description
3760 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
3763 \begin_layout Description
3773 \begin_inset Newline newline
3778 paragraph_spacing default|single|onehalf|double|other SIZE
3779 \begin_inset Newline newline
3784 align block|left|right|center|default
3785 \begin_inset Newline newline
3790 labelwidthstring WIDTH|
3795 \begin_layout Description
3796 Origin rgh, Aug 15 2007
3799 \begin_layout Subsection*
3800 LFUN_PARAGRAPH_PARAMS_APPLY
3803 \begin_layout Description
3804 Action Change paragraph settings.
3807 \begin_layout Description
3808 Notion Overwrite all nonspecified settings to the default ones.
3809 Use paragraph-params lfun if you don't want to overwrite others settings.
3812 \begin_layout Description
3813 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
3816 \begin_layout Description
3817 Params For parameters see LFUN_PARAGRAPH_PARAMS
3820 \begin_layout Description
3821 Origin leeming, 30 Mar 2004
3824 \begin_layout Subsection*
3825 LFUN_PARAGRAPH_UPDATE
3828 \begin_layout Description
3829 Action Updates the values inside the paragraph dialog from the paragraph.
3832 \begin_layout Description
3833 Notion This is internal LFUN, not to be used by users.
3834 Called internally by LFUN_DIALOG_UPDATE.
3837 \begin_layout Description
3838 Origin leeming, 13 Mar 2003
3841 \begin_layout Subsection*
3845 \begin_layout Description
3846 Action Move the current group in the upward direction in the structure of
3850 \begin_layout Description
3851 Notion The "group" can be Part/Chapter/Section/etc.
3852 It moves the whole substructure of the group.
3855 \begin_layout Description
3859 \begin_layout Description
3860 Origin Vermeer, 23 Mar 2006
3863 \begin_layout Subsection*
3867 \begin_layout Description
3868 Action Move the current group in the downward direction in the structure
3872 \begin_layout Description
3873 Notion The "group" can be Part/Chapter/Section/etc.
3874 It moves the whole substructure of the group.
3877 \begin_layout Description
3881 \begin_layout Description
3882 Origin Vermeer, 23 Mar 2006
3885 \begin_layout Subsection*
3889 \begin_layout Description
3890 Action Moves the current group in the downward direction in the hierarchy
3891 of the document structure.
3894 \begin_layout Description
3895 Notion Part -> Chapter -> Section -> etc.
3898 \begin_layout Description
3902 \begin_layout Description
3903 Origin Vermeer, 23 Mar 2006
3906 \begin_layout Subsection*
3910 \begin_layout Description
3911 Action Moves the current group in the upward direction in the hierarchy
3912 of the document structure.
3915 \begin_layout Description
3916 Notion Part <- Chapter <- Section <- etc.
3919 \begin_layout Description
3923 \begin_layout Description
3924 Origin Vermeer, 23 Mar 2006
3927 \begin_layout Subsection*
3931 \begin_layout Description
3932 Action Edit the inset at cursor with an external application, if one is
3936 \begin_layout Description
3937 Syntax inset-edit [<INSET_PARAMS>]
3940 \begin_layout Description
3941 Params <INSET_PARAMS>: Parameters for the inset.
3942 \begin_inset Newline newline
3945 Currently only the filename will be considered.
3948 \begin_layout Description
3949 Origin JSpitzm, 27 Apr 2006
3952 \begin_layout Subsection*
3956 \begin_layout Description
3957 Action Inserts table into the document.
3960 \begin_layout Description
3961 Notion See LFUN_INSET_MODIFY for some more details about tabular modifications.
3964 \begin_layout Description
3965 Syntax tabular-insert [<ROWS> <COLUMNS>]
3968 \begin_layout Description
3969 Params In case no arguments are given show insert dialog.
3972 \begin_layout Description
3973 Origin Jug, 12 Apr 2000
3976 \begin_layout Subsection*
3980 \begin_layout Description
3981 Action Moves the cursor to the previous cell inside the table.
3984 \begin_layout Description
3985 Syntax cell-backward
3988 \begin_layout Description
3989 Origin Jug, 22 May 2000
3992 \begin_layout Subsection*
3996 \begin_layout Description
3997 Action Moves the cursor to the next cell inside the table.
4000 \begin_layout Description
4004 \begin_layout Subsection*
4008 \begin_layout Description
4009 Action Splits cell and shifts right part to the next cell (inside the math
4013 \begin_layout Description
4017 \begin_layout Description
4018 Origin Ale, 15 May 1997
4021 \begin_layout Subsection*
4025 \begin_layout Description
4026 Action Register the document as an file inside version control system.
4029 \begin_layout Description
4030 Notion File is registered inside cvs, svn or rcs repository acording to
4031 the existence of cvs/svn/rcs entries in the document's directory.
4032 \begin_inset Newline newline
4035 See LyX Additional Features Manual (Version Control Chapter) for additional
4039 \begin_layout Description
4043 \begin_layout Description
4044 Origin Lgb, 1 Jul 1997
4047 \begin_layout Subsection*
4051 \begin_layout Description
4052 Action Checks-in/commits the changes of the registered file to the repository.
4055 \begin_layout Description
4056 Notion In RCS case this also unlocks the file.
4059 \begin_layout Description
4063 \begin_layout Description
4064 Origin Lgb, 1 Jul 1997
4067 \begin_layout Subsection*
4071 \begin_layout Description
4072 Action Checks-out the document for edit (and locks it in some cases).
4075 \begin_layout Description
4079 \begin_layout Description
4080 Origin Lgb, 1 Jul 1997
4083 \begin_layout Subsection*
4087 \begin_layout Description
4088 Action Reverts the document to the last check-in/commit in VCS.
4091 \begin_layout Description
4095 \begin_layout Description
4096 Origin Lgb, 1 Jul 1997
4099 \begin_layout Subsection*
4103 \begin_layout Description
4104 Action Undo last check-in.
4107 \begin_layout Description
4108 Notion This is currently implemented only for RCS.
4111 \begin_layout Description
4115 \begin_layout Description
4116 Origin Lgb, 1 Jul 1997
4119 \begin_layout Subsection*
4123 \begin_layout Description
4124 Action Executes external command.
4125 This command is intended to support additional VCS commands.
4128 \begin_layout Description
4129 Syntax vc-command <FLAG> <PATH> <COMMAND>
4132 \begin_layout Description
4133 Params <FLAG>: Flags for the command can be combined together.
4134 \begin_inset Newline newline
4137 U - dUmmy - no flags
4138 \begin_inset Newline newline
4141 D - Doc - need document loaded to proceed
4142 \begin_inset Newline newline
4145 I - dIrty - mark document dirty
4146 \begin_inset Newline newline
4149 R - Reload - ensure that the document is saved and reload it after command
4151 \begin_inset Newline newline
4154 M - Message - ask for input string (commit message)
4155 \begin_inset Newline newline
4158 <PATH>: path where to start.
4159 $$p will be replaced by the current document path.
4160 \begin_inset Newline newline
4163 <COMMAND>: command to execute.
4164 $$i/$$p/$$m will be replaced by the current document(with absolute path)/path/m
4168 \begin_layout Description
4169 Sample vc-command DR $$p "svn up"
4172 \begin_layout Description
4173 Origin sanda, 13 Jan 2009
4176 \begin_layout Subsection*
4177 LFUN_VC_LOCKING_TOGGLE
4180 \begin_layout Description
4181 Action Toggles the locking property of the edited file.
4184 \begin_layout Description
4185 Notion This is currently implemented only for SVN.
4188 \begin_layout Description
4189 Syntax vc-locking-toggle
4192 \begin_layout Description
4193 Origin sanda, 25 Jun 2009
4196 \begin_layout Subsection*
4200 \begin_layout Description
4201 Action Update the local archive directory in which resides the current document
4202 with the remote repository.
4205 \begin_layout Description
4206 Syntax vc-repo-update
4209 \begin_layout Description
4210 Origin sanda, 16 Oct 2009
4213 \begin_layout Subsection*
4217 \begin_layout Description
4218 Action Compares two revisions of the same file under version control.
4221 \begin_layout Description
4222 Syntax vc-compare [<REV1>] [<REV2>]
4225 \begin_layout Description
4226 Params Revision number either points directly to commit in history or if
4227 negative number -x it points to (last commit - x).
4228 \begin_inset Newline newline
4231 In RCS we subtract only in the last number of revision specification.
4232 Special case "0" is reserved for the last committed revision.
4233 \begin_inset Newline newline
4237 \begin_inset Newline newline
4241 Used only if REV1 > 0.
4242 \begin_inset Newline newline
4245 If no parameter is given, interactive dialog will be shown.
4248 \begin_layout Description
4249 Sample Compare current document against last commit
4250 \begin_inset Newline newline
4254 \begin_inset Newline newline
4257 Compare current document against current revision - 5 commits
4258 \begin_inset Newline newline
4262 \begin_inset Newline newline
4265 Compare revisions 120 and 155
4266 \begin_inset Newline newline
4272 \begin_layout Description
4273 Origin sanda, 12 Feb 2010
4276 \begin_layout Subsection*
4280 \begin_layout Description
4281 Action Toggles change tracking to on/off.
4284 \begin_layout Description
4285 Syntax changes-track
4288 \begin_layout Description
4289 Origin levon, 1 Oct 2002
4292 \begin_layout Subsection*
4296 \begin_layout Description
4297 Action Toggles showing of change tracking in typesetted output.
4300 \begin_layout Description
4301 Syntax changes-output
4304 \begin_layout Description
4305 Origin jspitzm, 21 Jan 2005
4308 \begin_layout Subsection*
4312 \begin_layout Description
4313 Action Moves the cursor to the position of the next change of the change
4317 \begin_layout Description
4321 \begin_layout Description
4322 Origin schmitt, 4 Oct 2006
4325 \begin_layout Subsection*
4326 LFUN_CHANGE_PREVIOUS
4329 \begin_layout Description
4330 Action Moves the cursor to the position of the previous change of the change
4334 \begin_layout Description
4335 Syntax change-previous
4338 \begin_layout Description
4339 Origin vfr, 4 Apr 2009
4342 \begin_layout Subsection*
4346 \begin_layout Description
4347 Action Open change tracking dialog for merging and moves the cursor to the
4348 position of the next change.
4351 \begin_layout Description
4352 Syntax changes-merge
4355 \begin_layout Description
4356 Origin Levon, 16 Oct 2002
4359 \begin_layout Subsection*
4363 \begin_layout Description
4364 Action Accepts tracked change inside the selection.
4367 \begin_layout Description
4368 Syntax change-accept
4371 \begin_layout Description
4372 Origin Levon, 16 Oct 2002
4375 \begin_layout Subsection*
4379 \begin_layout Description
4380 Action Rejects tracked change inside the selection.
4383 \begin_layout Description
4384 Syntax change-reject
4387 \begin_layout Description
4388 Origin Levon, 16 Oct 2002
4391 \begin_layout Subsection*
4392 LFUN_ALL_CHANGES_ACCEPT
4395 \begin_layout Description
4396 Action Accepts all tracked changes in the document.
4399 \begin_layout Description
4400 Syntax all-changes-accept
4403 \begin_layout Description
4404 Origin Levon, 16 Oct 2002
4407 \begin_layout Subsection*
4408 LFUN_ALL_CHANGES_REJECT
4411 \begin_layout Description
4412 Action Rejects all tracked changes in the document.
4415 \begin_layout Description
4416 Notion Reject does not work recursively; the user may have to repeat the
4420 \begin_layout Description
4421 Syntax all-changes-reject
4424 \begin_layout Description
4425 Origin Levon, 16 Oct 2002
4428 \begin_layout Subsection*
4432 \begin_layout Description
4433 Action Apply data for an inset.
4436 \begin_layout Description
4437 Notion LFUN_INSET_APPLY is sent from the dialogs when the data should be
4439 This is either changed to LFUN_INSET_MODIFY or LFUN_INSET_INSERT depending
4440 on the context where it is called.
4443 \begin_layout Description
4444 Syntax inset-apply <ARGS>
4447 \begin_layout Description
4448 Params See LFUN_INSET_INSERT .
4451 \begin_layout Subsection*
4455 \begin_layout Description
4456 Action Dissolve the current inset into text.
4459 \begin_layout Description
4460 Syntax inset-dissolve [<INSET>]
4463 \begin_layout Description
4464 Params <INSET>: this can be used to make sure the right kind of inset is
4466 For example "dissolve" entry in the charstyles sub-menu should only dissolve
4467 the charstyle inset, even if the cursor is inside several nested insets
4469 \begin_inset Newline newline
4472 For values see lyx::InsetLayout::lyxtype_ .
4475 \begin_layout Description
4476 Origin JSpitz, 7 Aug 2006
4479 \begin_layout Subsection*
4483 \begin_layout Description
4484 Action Insert new inset (type given by the parameters).
4487 \begin_layout Description
4488 Syntax inset-insert <INSET> <ARGS>
4491 \begin_layout Description
4492 Params <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|tabular|
4493 \begin_inset Newline newline
4496 hyperlink|include|index|label|line|nomencl|vspace|ref|toc|scri
4498 \begin_inset Newline newline
4501 <ARGS>: depends on the given inset.
4502 Use "lyx -dbg action" to explore.
4505 \begin_layout Description
4506 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
4509 \begin_inset Newline newline
4512 where <label name> is the name of the referenced label and <Format> is one
4514 \begin_inset Newline newline
4518 \begin_inset Newline newline
4521 eqref -- (<reference>)
4522 \begin_inset Newline newline
4526 \begin_inset Newline newline
4529 vpageref -- on <page>
4530 \begin_inset Newline newline
4533 vref -- <reference> on <page>
4534 \begin_inset Newline newline
4537 formatted -- Formatted reference
4540 \begin_layout Subsection*
4544 \begin_layout Description
4545 Action Modify some properties of an inset.
4548 \begin_layout Description
4549 Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats,
4550 graphics, include, index, info, label, listings, newline, newpage, nomencl,
4551 note, phantom, ref, space, tabular, vspace, wrap insets.
4554 \begin_layout Description
4555 Syntax inset-modify <INSET> <ARGS>inset-modify changetype <TYPE>inset-modify
4556 tabular <FEATURE> [<ARG>]
4559 \begin_layout Description
4560 Params Generally see LFUN_INSET_INSERT for further details.
4561 \begin_inset Newline newline
4564 In case that <INSET> is "tabular" various math-environment features are
4565 handled as well, e.g.
4566 add-vline-left/right for the Grid/Array environment.
4567 \begin_inset Newline newline
4570 <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|copy-colum
4571 n| toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
4572 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point
4573 | valign-top|valign-bottom|valign-middle|longtabular-align-left| longtabular-ali
4574 gn-center|longtabular-align-right|m-align-left|m-align-right| m-align-center|m-v
4575 align-top|m-valign-bottom|m-valign-middle|multicolumn| set-all-lines|unset-all-l
4576 ines|set-longtabular|unset-longtabular|set-pwidth| set-mpwidth|set-rotate-tabula
4577 r|unset-rotate-tabular|toggle-rotate-tabular| set-rotate-cell|unset-rotate-cell|
4578 toggle-rotate-cell|set-usebox|set-lthead| unset-lthead|set-ltfirsthead|unset-ltf
4579 irsthead|set-ltfoot|unset-ltfoot| set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|
4580 toggle-ltcaption| set-special-column|set-special-multicolumn|set-special-multiro
4581 w| set-booktabs|unset-booktabs|set-top-space|set-bottom-space| set-interline-spa
4582 ce|set-border-lines|tabular-valign-top| tabular-valign-middle|tabular-valign-bot
4583 tom|set-tabular-width
4584 \begin_inset Newline newline
4587 <ARG>: additional argument for some commands, use debug mode to explore
4591 \begin_layout Description
4592 Sample inset-modify note Note Comment
4593 \begin_inset Newline newline
4596 inset-modify changetype Ovalbox
4599 \begin_layout Subsection*
4600 LFUN_INSET_DIALOG_UPDATE
4603 \begin_layout Description
4604 Action Updates the values inside the dialog from the inset.
4607 \begin_layout Description
4608 Notion This is internal LFUN, not to be used by users.
4609 Called internally by LFUN_DIALOG_UPDATE
4612 \begin_layout Description
4613 Params <DIALOG-NAME>
4616 \begin_layout Description
4617 Origin leeming, 25 Feb 2003
4620 \begin_layout Subsection*
4624 \begin_layout Description
4625 Action Open the inset's properties dialog.
4628 \begin_layout Description
4629 Notion Used for bibitem, bibtex, box, branch, citation, ert, external, float,
4630 graphics, href, include, index, index_print, label, line, listings, note,
4631 phantom, ref, space, tabular, vspace, wrap insets.
4634 \begin_layout Description
4635 Syntax inset-settings <INSET>
4638 \begin_layout Description
4639 Params <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
4640 \begin_inset Newline newline
4643 graphics|href|include|index|index_print|label|line| listings|note|phantom|ref|sp
4644 ace|tabular|vspace|wrap>.
4647 \begin_layout Subsection*
4651 \begin_layout Description
4652 Action Toggles the collapsable inset at cursor position, or the inset we
4656 \begin_layout Description
4657 Syntax inset-toggle [<ARG>]
4660 \begin_layout Description
4661 Params <ARG>: <open|close|toggle|assign>.
4662 \begin_inset Newline newline
4665 open/close/toggle are for collapsable insets.
4666 toggle is used when no argument is given.
4667 \begin_inset Newline newline
4670 assign synchronize the branch-inset with activation status of the branch.
4671 Used for global toggling when changed activation.
4674 \begin_layout Description
4675 Origin lasgouttes, 19 Jul 2001
4678 \begin_layout Subsection*
4682 \begin_layout Description
4683 Action Apply the given commands on insets of a given name.
4686 \begin_layout Description
4687 Notion WARNING: use at your own risks; this function gives you too many
4688 ways of shooting yourself in the foot.
4689 A typical example is inset-forall Note note-insert which starts an infinite
4691 This is mitigated by the fact that the number of actions is arbitrarily
4693 Note also that inset-forall does not update metrics between iterations,
4694 which can lead to bugs.
4695 This has to be eventually fixed.
4698 \begin_layout Description
4699 Syntax inset-forall <NAME> <LFUN-COMMAND>
4700 \begin_inset Newline newline
4703 <NAME>: Type of Inset.
4704 If <NAME> is *, all insets are matched.
4705 The name is used like for InsetLayout in layout files: "Note" matches all
4706 note insets, while "Note:Note" only matches LyX yellow note insets.
4709 \begin_layout Description
4710 Sample Remove all index insets:
4711 \begin_inset Newline newline
4714 inset-forall Index delete-char-forward
4715 \begin_inset Newline newline
4718 Close all Notes (also works for a particular branch, for example):
4719 \begin_inset Newline newline
4722 inset-forall Note inset-toggle close
4723 \begin_inset Newline newline
4726 Transform all yellow notes to comments
4727 \begin_inset Newline newline
4730 inset-forall Note:Note inset-modify note Note Comment
4731 \begin_inset Newline newline
4734 Try to put LyX in an infinite loop if there is at least a Note:
4735 \begin_inset Newline newline
4738 inset-forall Note char-backward
4741 \begin_layout Description
4742 Origin lasgouttes, 27 Nov 2009
4745 \begin_layout Subsection*
4746 LFUN_GRAPHICS_RELOAD
4749 \begin_layout Description
4750 Action Reloads the image if necessary.
4753 \begin_layout Description
4754 Syntax graphics-reload
4757 \begin_layout Description
4758 Origin vfr, 10 Aug 2009
4761 \begin_layout Subsection*
4762 LFUN_SET_GRAPHICS_GROUP
4765 \begin_layout Description
4766 Action Set the group for the graphics inset on the cursor position.
4769 \begin_layout Description
4770 Syntax set-graphics-group [<GROUP>]
4773 \begin_layout Description
4774 Params <GROUP>: Id for an existing group.
4775 In case the Id is an empty string, the graphics inset is removed from the
4779 \begin_layout Description
4780 Origin sanda, 6 May 2008
4783 \begin_layout Subsection*
4784 LFUN_FINISHED_FORWARD
4787 \begin_layout Description
4788 Action Moves the cursor out of the current slice, going forward.
4791 \begin_layout Description
4792 Notion Cursor movement within an inset may be different than cursor movement
4793 in the surrounding text.
4794 This action should be called automatically by the cursor movement within
4795 the inset, when movement within the inset has ceased (reached the end of
4796 the last paragraph, for example), in order to move correctly back into
4797 the surrounding text.
4800 \begin_layout Subsection*
4801 LFUN_FINISHED_BACKWARD
4804 \begin_layout Description
4805 Action Moves the cursor out of the current slice, going backwards.
4808 \begin_layout Description
4809 Notion See also LFUN_FINISHED_FORWARD.
4812 \begin_layout Subsection*
4816 \begin_layout Description
4817 Action Moves the cursor out of the current slice, going right.
4820 \begin_layout Description
4821 Notion See also LFUN_FINISHED_FORWARD
4824 \begin_layout Subsection*
4828 \begin_layout Description
4829 Action Moves the cursor out of the current slice, going left.
4832 \begin_layout Description
4833 Notion See also LFUN_FINISHED_FORWARD.
4836 \begin_layout Subsection*
4840 \begin_layout Description
4841 Action Set language from the current cursor position.
4844 \begin_layout Description
4845 Syntax language <LANG>
4848 \begin_layout Description
4849 Params <LANG>: Requested language.
4850 Look in lib/languages for the list.
4853 \begin_layout Description
4854 Origin Dekel, 2 Mar 2000
4857 \begin_layout Subsection*
4861 \begin_layout Description
4862 Action Goto a label.
4865 \begin_layout Description
4866 Syntax label-goto [<LABEL>]
4869 \begin_layout Description
4870 Params <LABEL>: Requested label.
4871 If no label is given and reference is on cursor position, Bookmark 0 is
4872 saved and cursor moves to the position of referenced label.
4875 \begin_layout Description
4876 Origin Ale, 6 Aug 1997
4879 \begin_layout Subsection*
4883 \begin_layout Description
4884 Action Inserts label to text or displayed formula.
4887 \begin_layout Description
4888 Syntax label-insert [<LABEL>]
4891 \begin_layout Description
4892 Params <LABEL>: Requested label.
4893 If no label is given dialog requesting name will be opened.
4896 \begin_layout Subsection*
4900 \begin_layout Description
4901 Action Go to the next label or cross-reference.
4904 \begin_layout Description
4905 Syntax reference-next
4908 \begin_layout Description
4909 Origin Dekel, 14 Jan 2001
4912 \begin_layout Subsection*
4916 \begin_layout Description
4917 Action Moves the cursor to the numbered bookmark, opening the file if necessary.
4918 Note that bookmarsk are saved per-session, not per file.
4921 \begin_layout Description
4922 Notion Bookmark 0 has a special purpose.
4923 It is automatically set
4924 \begin_inset Newline newline
4928 to the paragraph you are currently editing
4929 \begin_inset Newline newline
4933 to the paragraph from where you are jumping to the last-edited position
4935 \begin_inset Newline newline
4939 when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
4942 \begin_layout Description
4943 Syntax bookmark-goto <NUMBER>
4946 \begin_layout Description
4947 Params <NUMBER>: the number of the bookmark to restore.
4950 \begin_layout Description
4951 Origin Dekel, 27 January 2001
4954 \begin_layout Subsection*
4958 \begin_layout Description
4959 Action Save a bookmark.
4962 \begin_layout Description
4963 Notion Saves a numbered bookmark to the sessions file.
4964 The number must be between 1 and 9, inclusive.
4965 Note that bookmarks are saved per-session, not per file.
4968 \begin_layout Description
4969 Syntax bookmark-save <NUMBER>
4972 \begin_layout Description
4973 Params <NUMBER>: the number of the bookmark to save.
4976 \begin_layout Description
4977 Origin Dekel, 27 January 2001
4980 \begin_layout Subsection*
4984 \begin_layout Description
4985 Action Clears the list of saved bookmarks.
4988 \begin_layout Description
4989 Syntax bookmark-clear
4992 \begin_layout Description
4993 Origin bpeng, 31 October 2006
4996 \begin_layout Subsection*
5000 \begin_layout Description
5001 Action Open the given help file according to the language setting.
5004 \begin_layout Description
5005 Syntax help-open <FILE>[.lyx]
5008 \begin_layout Description
5009 Params <FILE>: any document from (/usr/share/)doc directory.
5012 \begin_layout Description
5013 Origin Jug, 27 Jun 1999
5016 \begin_layout Subsection*
5020 \begin_layout Description
5021 Action Terminates the current LyX instance.
5024 \begin_layout Description
5025 Notion Terminates the current LyX instance, asking whether to save modified
5029 \begin_layout Description
5033 \begin_layout Subsection*
5037 \begin_layout Description
5038 Action Toggles visibility of a given toolbar between on/off/auto.
5041 \begin_layout Description
5042 Notion Skipping "auto" when allowauto is false.
5045 \begin_layout Description
5046 Syntax toolbar-toggle <NAME> [allowauto]
5049 \begin_layout Description
5050 Params <NAME>: standard|extra|table|math|mathmacrotemplate|
5051 \begin_inset Newline newline
5054 minibuffer|review|view/update|math_panels|vcs| view-others|update-others
5057 \begin_layout Description
5058 Origin Edwin, 21 May 2007
5061 \begin_layout Subsection*
5065 \begin_layout Description
5066 Action Opens the menu given by its name.
5069 \begin_layout Description
5070 Syntax menu-open <NAME>
5073 \begin_layout Description
5074 Params <NAME>: menu name.
5075 See various .inc files in lib/ui for candidates.
5078 \begin_layout Subsection*
5082 \begin_layout Description
5083 Action Various UI visibility-toggling actions.
5086 \begin_layout Description
5087 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
5090 \begin_layout Description
5091 Params statusbar : Toggle visibility of the statusbar.
5092 \begin_inset Newline newline
5095 menubar : Toggle visibility of the menubar.
5096 \begin_inset Newline newline
5099 scrollbar : Toggle visibility of the scrollbar.
5100 \begin_inset Newline newline
5103 frame : Toggle visibility of the frames around editing window.
5104 \begin_inset Newline newline
5107 fullscreen : Toggle fullscreen mode.
5108 This also covers calling the previous functions.
5109 However LFUN_TOOLBAR_TOGGLE for the custom tweaks of the toolbars should
5113 \begin_layout Description
5114 Origin sanda, 9 Feb 2007
5117 \begin_layout Subsection*
5121 \begin_layout Description
5122 Action Creates new empty LyX window.
5125 \begin_layout Description
5126 Notion Already opened documents from the previous window can be found under
5130 \begin_layout Description
5131 Syntax window-new [<GEOMETRY>]
5134 \begin_layout Description
5135 Params <GEOMETRY>: pass the geometry of the window.
5136 This parameter is currently accepted only on Windows platform.
5139 \begin_layout Description
5140 Origin Abdel, 21 Oct 2006
5143 \begin_layout Subsection*
5147 \begin_layout Description
5148 Action Closes the current LyX window.
5151 \begin_layout Description
5155 \begin_layout Description
5156 Origin Abdel, 23 Oct 2006
5159 \begin_layout Subsection*
5163 \begin_layout Description
5164 Action Creates another split view of current buffer.
5167 \begin_layout Description
5168 Notion All split views act in the same way indpendently.
5171 \begin_layout Description
5172 Syntax split-view <vertical|horizontal>
5175 \begin_layout Description
5176 Params horizontal : The work areas are laid out side by side.
5177 \begin_inset Newline newline
5180 vertical : The work areas laid out vertically.
5183 \begin_layout Description
5184 Origin Abdel, 20 Feb 2008
5187 \begin_layout Subsection*
5188 LFUN_CLOSE_TAB_GROUP
5191 \begin_layout Description
5192 Action Close the current tab group.
5195 \begin_layout Description
5196 Notion This only closes the work areas, not the buffer themselves.
5197 The still opened buffers can be visualized in another tab group.
5200 \begin_layout Description
5201 Syntax close-tab-group
5204 \begin_layout Description
5205 Origin Abdel, 21 Feb 2008
5208 \begin_layout Subsection*
5212 \begin_layout Description
5213 Action Shows hidden dialog or create new one for a given function/inset
5217 \begin_layout Description
5218 Syntax dialog-show <NAME> [<DATA>]
5221 \begin_layout Description
5222 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
5223 \begin_inset Newline newline
5226 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|
5227 \begin_inset Newline newline
5230 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimit
5232 \begin_inset Newline newline
5235 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|
5236 \begin_inset Newline newline
5239 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|
5240 \begin_inset Newline newline
5243 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL>
5244 \begin_inset Newline newline
5247 <SPECIAL>: latexlog|vclog
5248 \begin_inset Newline newline
5251 <DATA>: data, usually settings for the given dialog.
5252 Use debug mode for the details.
5255 \begin_layout Description
5256 Origin leeming, 17 Jun 2003
5259 \begin_layout Subsection*
5260 LFUN_DIALOG_SHOW_NEW_INSET
5263 \begin_layout Description
5264 Action Shows hidden dialog or create new one for a given inset settings
5268 \begin_layout Description
5269 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given
5273 \begin_layout Description
5274 Syntax dialog-show-new-inset <NAME> [<DATA>]
5277 \begin_layout Description
5278 Params See LFUN_DIALOG_SHOW .
5281 \begin_layout Description
5282 Origin leeming, 25 Feb 2003
5285 \begin_layout Subsection*
5289 \begin_layout Description
5290 Action Updates the dialog values from the inset/paragraph/document.
5293 \begin_layout Description
5294 Syntax dialog-update <NAME>
5297 \begin_layout Description
5298 Params <NAME>: paragraph|prefs|<INSET>
5299 \begin_inset Newline newline
5305 \begin_layout Description
5306 Origin leeming, 25 Feb 2003
5309 \begin_layout Subsection*
5313 \begin_layout Description
5314 Action Hides showed dialog.
5315 Counterpart to LFUN_DIALOG_SHOW .
5318 \begin_layout Description
5319 Syntax dialog-hide <NAME>
5322 \begin_layout Description
5323 Params See LFUN_DIALOG_SHOW .
5326 \begin_layout Description
5327 Origin leeming, 25 Feb 2003
5330 \begin_layout Subsection*
5334 \begin_layout Description
5335 Action Toggles dialog between showed/hidden state.
5338 \begin_layout Description
5339 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
5342 \begin_layout Description
5343 Syntax dialog-toggle <NAME> [<DATA>]
5346 \begin_layout Description
5347 Params See LFUN_DIALOG_SHOW .
5350 \begin_layout Description
5351 Origin JSpitzm, 30 Apr 2007
5354 \begin_layout Subsection*
5355 LFUN_DIALOG_DISCONNECT_INSET
5358 \begin_layout Description
5359 Action Closes opened connection to opened inset.
5362 \begin_layout Description
5363 Notion Connection is used for apply functions.
5366 \begin_layout Description
5367 Syntax dialog-disconnect-inset <INSET-NAME>
5370 \begin_layout Description
5371 Origin leeming, 25 Feb 2003
5374 \begin_layout Subsection*
5378 \begin_layout Description
5379 Action This function is called when mouse button is pressed (inside workarea).
5380 Action depends on the context.
5383 \begin_layout Description
5384 Notion This is internal LFUN, not to be used by users.
5387 \begin_layout Description
5388 Origin Andre, 9 Aug 2002
5391 \begin_layout Subsection*
5395 \begin_layout Description
5396 Action This function is called when double click on mouse button is pressed
5398 Action depends on the context.
5401 \begin_layout Description
5402 Notion This is internal LFUN, not to be used by users.
5405 \begin_layout Description
5406 Origin Andre, 9 Aug 2002
5409 \begin_layout Subsection*
5413 \begin_layout Description
5414 Action This function is called when triple click on mouse button is pressed
5416 Action depends on the context.
5419 \begin_layout Description
5420 Notion This is internal LFUN, not to be used by users.
5423 \begin_layout Description
5424 Origin Andre, 9 Aug 2002
5427 \begin_layout Subsection*
5431 \begin_layout Description
5432 Action This function is called when mouse cursor is moving over the text.
5433 Action depends on the context.
5436 \begin_layout Description
5437 Notion This is internal LFUN, not to be used by users.
5440 \begin_layout Description
5441 Origin Andre, 9 Aug 2002
5444 \begin_layout Subsection*
5448 \begin_layout Description
5449 Action This function is called when mouse button is released (inside workarea).
5450 Action depends on the context.
5453 \begin_layout Description
5454 Notion This is internal LFUN, not to be used by users.
5457 \begin_layout Description
5458 Origin Andre, 9 Aug 2002
5461 \begin_layout Subsection*
5465 \begin_layout Description
5466 Action Turn off the loaded keyboard map.
5469 \begin_layout Description
5473 \begin_layout Subsection*
5477 \begin_layout Description
5478 Action Turn on the primary keyboard map.
5481 \begin_layout Description
5482 Notion Maps were widely used in past, when X-windows didn't have nowadays
5484 They can be still used to maintain uniform keyboard layout across the various
5486 \begin_inset Newline newline
5489 The language is to be set in the Preferences dialog.
5492 \begin_layout Description
5493 Syntax keymap-primary
5496 \begin_layout Subsection*
5497 LFUN_KEYMAP_SECONDARY
5500 \begin_layout Description
5501 Action Turn on the secondary keyboard map.
5504 \begin_layout Description
5505 Syntax keymap-secondary
5508 \begin_layout Subsection*
5512 \begin_layout Description
5513 Action Toggles keyboard maps (first/second/off).
5516 \begin_layout Description
5517 Syntax keymap-toggle
5520 \begin_layout Description
5521 Origin leeming, 30 Mar 2004
5524 \begin_layout Subsection*
5525 LFUN_SERVER_GET_LAYOUT
5528 \begin_layout Description
5529 Action Returns the current layout (that is environment) name on the cursor
5533 \begin_layout Description
5534 Syntax server-get-layout
5537 \begin_layout Subsection*
5538 LFUN_SERVER_GET_FILENAME
5541 \begin_layout Description
5542 Action Returns path and file name of the currently edited document.
5545 \begin_layout Description
5546 Syntax server-get-filename
5549 \begin_layout Subsection*
5550 LFUN_SERVER_GOTO_FILE_ROW
5553 \begin_layout Description
5554 Action Sets the cursor position in LyX based on the row number of generated
5558 \begin_layout Description
5559 Notion This can be useful for DVI inverse-search or detection of the problematic
5560 line from LaTeX compilation.
5561 Note that before this function can be used export to LaTeX output must
5562 occur (in order to map the row numbers).
5565 \begin_layout Description
5566 Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
5569 \begin_layout Description
5570 Params <FILE>: the path and filename.
5571 Environment variables are expanded in the path.
5572 In case this LFUN does not work make sure you are giving correct path to
5574 \begin_inset Newline newline
5577 If the file is located inside LyX temporary directory it will be mapped
5578 back into the appropriate opened buffer (e.g.
5579 for the case of generated .tex file).
5580 \begin_inset Newline newline
5583 .ext: extensions will be automatically replaced by .lyx.
5584 \begin_inset Newline newline
5587 <ROW_NUMBER> The row number of the LaTeX file to which to go.
5590 \begin_layout Description
5591 Sample server-goto-file-row /home/user/example.lyx 41
5592 \begin_inset Newline newline
5595 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
5598 \begin_layout Description
5599 Origin Edmar, 23 Dec 1998
5602 \begin_layout Subsection*
5606 \begin_layout Description
5607 Action Sets the cursor position in the previewed (dvi/pdf) file based on
5608 the row number in LyX window.
5611 \begin_layout Description
5612 Notion The external program used for forward search call can be specified
5613 in LyX Output preferences.
5614 See Additional manual for details of these settings.
5617 \begin_layout Description
5618 Syntax forward-search
5621 \begin_layout Description
5622 Origin sanda, 14 Apr 2010
5625 \begin_layout Subsection*
5629 \begin_layout Description
5630 Action Sends notify message about the last key-sequence to client.
5633 \begin_layout Description
5634 Notion This can be used to grab last key-sequence used inside the LyX window.
5635 See also Debug extensions section in Additional features manual.
5638 \begin_layout Description
5639 Syntax server-notify
5642 \begin_layout Subsection*
5646 \begin_layout Description
5647 Action Sets the cursor position based on the editing area coordinates (similar
5648 as clicking on that point with left mouse button).
5651 \begin_layout Description
5652 Syntax server-set-xy <X> <Y>
5655 \begin_layout Subsection*
5659 \begin_layout Description
5660 Action Returns the coordinates of cursor position in the editing area.
5663 \begin_layout Description
5664 Syntax server-get-xy
5667 \begin_layout Subsection*
5671 \begin_layout Description
5672 Action Generates the code (literate programming).
5675 \begin_layout Description
5676 Notion Latex file with extension
5678 literate_extension is generated.
5681 build_command (with a default of``make'') to generate the code and
5683 build_error_filter to process the compilation error messages.
5684 \begin_inset Newline newline
5687 In case you want to process your literate file with a script, or some other
5688 program, just insert in your lyxrc file an entry with:
5689 \begin_inset Newline newline
5694 build_command "my_script my_arguments"
5695 \begin_inset Newline newline
5700 build_error_filter differs from the
5702 literate_error_filter only in that the former will identify error messages
5706 \begin_layout Description
5707 Syntax build-program
5710 \begin_layout Subsection*
5711 LFUN_BUFFER_AUTO_SAVE
5714 \begin_layout Description
5715 Action Saves the current buffer to a temporary file.
5718 \begin_layout Description
5719 Notion Saves the current buffer to a file named "#filename#".
5720 This LFUN is called automatically by LyX, to "autosave" the current buffer.
5723 \begin_layout Description
5724 Syntax buffer-auto-save
5727 \begin_layout Subsection*
5728 LFUN_BUFFER_CHILD_OPEN
5731 \begin_layout Description
5732 Action Loads the given child document.
5735 \begin_layout Description
5736 Notion The current document is treated as a parent.
5739 \begin_layout Description
5740 Syntax buffer-child-open <FILE>
5743 \begin_layout Description
5744 Params <FILE>: Filename of the child.
5745 The directory of the parent is assumed by default.
5748 \begin_layout Description
5749 Origin Ale, 28 May 1997
5752 \begin_layout Subsection*
5756 \begin_layout Description
5757 Action Runs chktex for the current document.
5760 \begin_layout Description
5761 Syntax buffer-chktex
5764 \begin_layout Description
5765 Origin Asger, 30 Oct 1997
5768 \begin_layout Subsection*
5769 LFUN_BUFFER_TOGGLE_COMPRESSION
5772 \begin_layout Description
5773 Action Toggles compression of the current document on/off.
5776 \begin_layout Description
5777 Syntax buffer-toggle-compression
5780 \begin_layout Description
5781 Origin bpeng, 27 Apr 2006
5784 \begin_layout Subsection*
5785 LFUN_BUFFER_TOGGLE_OUTPUT_SYNC
5788 \begin_layout Description
5789 Action Toggles including of resources for forward/reverse search of the
5793 \begin_layout Description
5794 Notion When toggled on, SyncTeX is invoked for PDF, while srcltx package
5796 Custom LaTeX macro can be defined in preferences.
5799 \begin_layout Description
5800 Syntax buffer-toggle-output-sync
5803 \begin_layout Description
5804 Origin sanda, 25 May 2010
5807 \begin_layout Subsection*
5811 \begin_layout Description
5812 Action Closes the current buffer.
5815 \begin_layout Description
5816 Notion Closes the current buffer, asking whether to save it, etc, if the
5817 buffer has been modified.
5820 \begin_layout Description
5824 \begin_layout Subsection*
5825 LFUN_BUFFER_CLOSE_ALL
5828 \begin_layout Description
5829 Action Closes all buffers.
5832 \begin_layout Description
5833 Notion Closes all buffers, asking whether to save it, etc, if a buffer has
5837 \begin_layout Description
5838 Syntax buffer-close-all
5841 \begin_layout Subsection*
5845 \begin_layout Description
5846 Action Exports the current buffer (document) to the given format.
5849 \begin_layout Description
5850 Syntax buffer-export <FORMAT>
5853 \begin_layout Description
5854 Params <FORMAT> is either "custom" or one of the formats which you can find
5855 in Tools->Preferences->File formats->Format.
5856 Usual format you will enter is "pdf2" (pdflatex), "pdflatex" (plain tex
5857 for pdflatex) or "ps" for postscript.
5858 \begin_inset Newline newline
5861 In case of "custom" you will be asked for a format you want to start from
5862 and for the command that you want to apply to this format.
5863 Internally the control is then passed to LFUN_BUFFER_EXPORT_CUSTOM.
5866 \begin_layout Description
5867 Origin Lgb, 29 Jul 1997
5870 \begin_layout Subsection*
5871 LFUN_BUFFER_EXPORT_CUSTOM
5874 \begin_layout Description
5875 Action Exports the current buffer (document) from the given format using
5876 the given command on it.
5879 \begin_layout Description
5880 Syntax buffer-export-custom <FORMAT> <COMMAND>
5883 \begin_layout Description
5884 Params <FORMAT> format to start from (LyX will care to produce such intermediate
5886 \begin_inset Newline newline
5889 <COMMAND> this command will be launched on the file.
5890 Note that you can use "$$FName" string to qualify the intermediate file.
5893 \begin_layout Description
5894 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
5897 \begin_layout Description
5898 Origin leeming, 27 Mar 2004
5901 \begin_layout Subsection*
5905 \begin_layout Description
5906 Action Prints the current document.
5909 \begin_layout Description
5910 Notion Many settings can be given via the preferences dialog.
5913 \begin_layout Description
5914 Syntax buffer-print <TARGET> <TARGET-NAME> <COMMAND>
5917 \begin_layout Description
5918 Params <TARGET> is either "printer" or "file".
5919 \begin_inset Newline newline
5922 <TARGER-NAME> is either "default" or file name or printer name.
5923 \begin_inset Newline newline
5926 <COMMAND> command ensuring the printing job.
5929 \begin_layout Description
5930 Sample buffer-print file "/trash/newfile1.ps" "dvips"
5933 \begin_layout Description
5934 Origin leeming, 28 Mar 2004
5937 \begin_layout Subsection*
5941 \begin_layout Description
5942 Action Import a given file as a lyx document.
5945 \begin_layout Description
5946 Notion File can be imported iff lyx file format is (transitively) reachable
5947 via defined convertors in preferences.
5948 Look into File->Import menu to get an idea of the currently active import
5952 \begin_layout Description
5953 Syntax buffer-import <FORMAT> [<FILE>]
5956 \begin_layout Description
5957 Origin Asger, 24 Jul 1998
5960 \begin_layout Subsection*
5964 \begin_layout Description
5965 Action Creates a new buffer (that is, document).
5968 \begin_layout Description
5969 Notion Implicit path can be set in Preferences dialog.
5972 \begin_layout Description
5973 Syntax buffer-new [<FILE>]
5976 \begin_layout Description
5977 Params <FILE>: filename of created file with absolute path.
5980 \begin_layout Subsection*
5981 LFUN_BUFFER_NEW_TEMPLATE
5984 \begin_layout Description
5985 Action Creates a new buffer (that is, document) from a template.
5988 \begin_layout Description
5989 Notion Path for new files and templates can be set in Preferences dialog.
5990 Template will be asked for via Open-dialog.
5993 \begin_layout Description
5994 Syntax buffer-new-template [<FILE>]
5997 \begin_layout Description
5998 Params <FILE>: filename of created file with absolute path.
6001 \begin_layout Subsection*
6005 \begin_layout Description
6006 Action Reverts opened document.
6009 \begin_layout Description
6010 Syntax buffer-reload
6013 \begin_layout Description
6014 Origin Asger, 2 Feb 1997
6017 \begin_layout Subsection*
6021 \begin_layout Description
6022 Action Display/switch to the given buffer.
6025 \begin_layout Description
6026 Syntax buffer-switch <BUFFER>
6029 \begin_layout Description
6030 Params <BUFFER>: path and filename of already opened (but possibly hidden)
6031 document which is to be shown.
6034 \begin_layout Subsection*
6035 LFUN_BUFFER_TOGGLE_READ_ONLY
6038 \begin_layout Description
6039 Action Toggle editing mode of the current document between read/write and
6043 \begin_layout Description
6044 Notion This function is not allowed if the file is under version control,
6045 since read-only flag is often used in version control file locking.
6048 \begin_layout Description
6049 Syntax buffer-toggle-read-only
6052 \begin_layout Description
6053 Origin Lgb, 27 May 1997
6056 \begin_layout Subsection*
6060 \begin_layout Description
6061 Action Displays current buffer in chosen format.
6064 \begin_layout Description
6065 Notion Displays the contents of the current buffer in the chosen format,
6066 for example, PDF or DVI.
6067 This runs the necessary converter, calls the defined viewer, and so forth.
6070 \begin_layout Description
6071 Syntax buffer-view [<FORMAT>]
6074 \begin_layout Description
6075 Params <FORMAT>: The format to display, where this is one of the formats
6076 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
6077 If no format is given, the default format as specified in the same dialog
6081 \begin_layout Subsection*
6085 \begin_layout Description
6086 Action Exports the current document and put the result into the temporary
6090 \begin_layout Description
6091 Notion In case you are already viewing the exported document (see LFUN_BUFFER_VI
6092 EW) the output will be rewriten - updated.
6093 This is useful in case your viewer is able to detect such changes (e.g.
6094 ghostview for postscript).
6097 \begin_layout Description
6098 Syntax buffer-update [<FORMAT>]
6101 \begin_layout Description
6102 Params <FORMAT>: The format to display, where this is one of the formats
6103 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
6104 If no format is given, the default format as specified in the same dialog
6108 \begin_layout Description
6109 Origin Dekel, 5 Aug 2000
6112 \begin_layout Subsection*
6116 \begin_layout Description
6117 Action Saves the current buffer.
6120 \begin_layout Description
6121 Notion Saves the current buffer to disk, using the filename that is already
6122 associated with the buffer, asking for one if none is yet assigned.
6125 \begin_layout Description
6129 \begin_layout Subsection*
6130 LFUN_BUFFER_WRITE_AS
6133 \begin_layout Description
6134 Action Rename and save current buffer.
6137 \begin_layout Description
6138 Syntax buffer-write-as <FILENAME>
6141 \begin_layout Description
6142 Params <FILENAME>: New name of the buffer/file.
6143 A relative path is with respect to the original location of the buffer/file.
6146 \begin_layout Subsection*
6147 LFUN_BUFFER_WRITE_ALL
6150 \begin_layout Description
6151 Action Save all changed documents.
6154 \begin_layout Description
6155 Syntax buffer-write-all
6158 \begin_layout Description
6159 Origin rgh, gpothier 6 Aug 2007
6162 \begin_layout Subsection*
6166 \begin_layout Description
6167 Action Switch to the next opened document.
6170 \begin_layout Description
6171 Notion Note that this does not necessarily mean next in tabbar (for full
6172 list see View menu).
6175 \begin_layout Description
6179 \begin_layout Subsection*
6180 LFUN_BUFFER_PREVIOUS
6183 \begin_layout Description
6184 Action Switch to the previous opened document.
6187 \begin_layout Description
6188 Syntax buffer-previous
6191 \begin_layout Subsection*
6192 LFUN_MASTER_BUFFER_UPDATE
6195 \begin_layout Description
6196 Action When run from a child document, this updates (exports) document built
6197 from the master buffer, if available.
6200 \begin_layout Description
6201 Syntax master-buffer-update [<FORMAT>]
6204 \begin_layout Description
6205 Params <FORMAT>: The format to display, where this is one of the formats
6206 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
6207 If no format is given, the default format as specified in the same dialog
6211 \begin_layout Description
6212 Origin Tommaso, 20 Sep 2007
6215 \begin_layout Subsection*
6216 LFUN_MASTER_BUFFER_VIEW
6219 \begin_layout Description
6220 Action When run from a child document, this command shows a preview built
6221 from the master buffer, if available.
6224 \begin_layout Description
6225 Syntax master-buffer-view [<FORMAT>]
6228 \begin_layout Description
6229 Params <FORMAT>: The format to display, where this is one of the formats
6230 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
6231 If no format is given, the default format as specified in the same dialog
6235 \begin_layout Description
6236 Origin Tommaso, 20 Sep 2007
6239 \begin_layout Subsection*
6240 LFUN_BUFFER_LANGUAGE
6243 \begin_layout Description
6244 Action Set language of the current document.
6247 \begin_layout Description
6248 Syntax buffer-language <LANG>
6251 \begin_layout Description
6252 Params <LANG>: language name.
6253 See lib/languages for list.
6256 \begin_layout Description
6257 Origin leeming, 30 Mar 2004
6260 \begin_layout Subsection*
6261 LFUN_BUFFER_SAVE_AS_DEFAULT
6264 \begin_layout Description
6265 Action Save the current document settings as default.
6268 \begin_layout Description
6269 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
6272 \begin_layout Description
6273 Syntax buffer-save-as-default [<ARGS>]
6276 \begin_layout Description
6277 Params <ARGS>: contains the particular settings to be saved.
6278 They obey the syntax you can find in document header of usual .lyx file.
6281 \begin_layout Description
6282 Origin leeming, 30 Mar 2004
6285 \begin_layout Subsection*
6286 LFUN_BUFFER_PARAMS_APPLY
6289 \begin_layout Description
6290 Action Apply the given settings to the current document.
6293 \begin_layout Description
6294 Syntax buffer-params-apply [<ARGS>]
6297 \begin_layout Description
6298 Params <ARGS>: contains the particular settings to be saved.
6299 They obey the syntax you can find in document header of usual .lyx file.
6302 \begin_layout Description
6303 Origin leeming, 30 Mar 2004
6306 \begin_layout Subsection*
6310 \begin_layout Description
6311 Action Inserts another LyX file.
6314 \begin_layout Description
6315 Syntax file-insert [<FILE>]
6318 \begin_layout Description
6319 Params <FILE>: Filename to be inserted.
6322 \begin_layout Subsection*
6323 LFUN_FILE_INSERT_PLAINTEXT
6326 \begin_layout Description
6327 Action Inserts plain text file.
6330 \begin_layout Description
6331 Syntax file-insert-plaintext [<FILE>]
6334 \begin_layout Description
6335 Params <FILE>: Filename to be inserted.
6338 \begin_layout Description
6339 Origin CFO-G, 19 Nov 1997
6342 \begin_layout Subsection*
6343 LFUN_FILE_INSERT_PLAINTEXT_PARA
6346 \begin_layout Description
6347 Action Inserts plain text file as paragraph (i.e.
6351 \begin_layout Description
6352 Syntax file-insert-plaintext-para [<FILE>]
6355 \begin_layout Description
6356 Params <FILE>: Filename to be inserted.
6359 \begin_layout Description
6360 Origin Levon, 14 Feb 2001
6363 \begin_layout Subsection*
6367 \begin_layout Description
6368 Action Open LyX document.
6371 \begin_layout Description
6372 Syntax file-open [<FILE>]
6375 \begin_layout Description
6376 Params <FILE>: Filename to be opened.
6379 \begin_layout Subsection*
6383 \begin_layout Description
6384 Action Executes a command defined in a .def file.
6387 \begin_layout Description
6388 Notion The definitions are by default read from lib/commands/default.def.
6389 \begin_inset Newline newline
6392 A .def file allows to define a command with
6394 define "<NAME>" "<LFUN>" where <NAME> is the name of the new command and
6395 <LFUN> is the lfun code to be executed (see e.g.
6396 LFUN_COMMAND_SEQUENCE).
6399 def_file "FileName" allows to include another .def file.
6400 \begin_inset Newline newline
6403 This is particularly useful in connection with toolbar buttons: Since the
6404 name of the button image for this lfun is lib/images/commands/<NAME>.png
6405 this is the way to assign an image to a complex command-sequence.
6408 \begin_layout Description
6412 \begin_layout Description
6413 Params <NAME>: Name of the command that must be called.
6416 \begin_layout Description
6417 Origin broider, 2 Oct 2007
6420 \begin_layout Subsection*
6424 \begin_layout Description
6425 Action Simulate halting Meta key (Alt key on PCs).
6428 \begin_layout Description
6429 Notion Used for buffer editation not for GUI control.
6432 \begin_layout Description
6436 \begin_layout Subsection*
6440 \begin_layout Description
6441 Action Cancels sequence prepared by LFUN_META_PREFIX .
6444 \begin_layout Description
6448 \begin_layout Subsection*
6449 LFUN_COMMAND_EXECUTE
6452 \begin_layout Description
6453 Action Switches the focus to the minibuffer so that the user can type in
6455 If necessary, it opens the minibuffer toolbar.
6458 \begin_layout Description
6459 Notion Usually bound to M-x shortcut.
6462 \begin_layout Description
6463 Syntax command-execute
6466 \begin_layout Subsection*
6470 \begin_layout Description
6471 Action Return the current key sequence and available options as a string.
6474 \begin_layout Description
6475 Notion No options are added if no current map exists.
6476 \begin_inset Newline newline
6479 This is probably usable only with connection to lyxserver.
6482 \begin_layout Description
6483 Syntax command-prefix
6486 \begin_layout Subsection*
6487 LFUN_COMMAND_SEQUENCE
6490 \begin_layout Description
6491 Action Run more commands (LFUN and its parameters) in a sequence.
6494 \begin_layout Description
6495 Syntax command-sequence <CMDS>
6498 \begin_layout Description
6499 Params <CMDS>: Sequence of commands separated by semicolons.
6502 \begin_layout Description
6503 Sample command-sequence cut; ert-insert; self-insert
6505 ; paste; self-insert {}; inset-toggle;
6508 \begin_layout Description
6509 Origin Andre, 11 Nov 1999
6512 \begin_layout Subsection*
6513 LFUN_COMMAND_ALTERNATIVES
6516 \begin_layout Description
6517 Action Runs the first listed command that is enabled.
6520 \begin_layout Description
6521 Notion This can be used to bind multiple functions to a single key, and
6522 then which one is used will depend upon the context.
6525 \begin_layout Description
6526 Syntax command-alternatives <CMDS>
6529 \begin_layout Description
6530 Params <CMDS>: Sequence of commands separated by semicolons.
6533 \begin_layout Description
6534 Sample command-alternatives completion-accept;cell-forward
6537 \begin_layout Description
6538 Origin rgh, 24 September 2008
6541 \begin_layout Subsection*
6545 \begin_layout Description
6546 Action Shows message in statusbar (for script purposes).
6549 \begin_layout Description
6550 Syntax message <STRING>
6553 \begin_layout Description
6554 Origin Lgb, 8 Apr 2001
6557 \begin_layout Subsection*
6558 LFUN_DEBUG_LEVEL_SET
6561 \begin_layout Description
6562 Action Set debug output level.
6565 \begin_layout Description
6566 Syntax debug-level-set <LEVEL>
6569 \begin_layout Description
6570 Params <LEVEL>: comma separated list of levels or the correspondent number
6571 of their combination.
6572 0 is equivalent to disabling all debug events.
6573 See lyx -dbg for the current list of debug levels and their numbers.
6576 \begin_layout Description
6577 Origin sanda, 28 Dec 2009
6580 \begin_layout Subsection*
6581 LFUN_PREFERENCES_SAVE
6584 \begin_layout Description
6585 Action Save user preferences.
6588 \begin_layout Description
6589 Syntax preferences-save
6592 \begin_layout Description
6593 Origin Lgb, 27 Nov 1999
6596 \begin_layout Subsection*
6600 \begin_layout Description
6601 Action Reconfigure the automatic settings.
6604 \begin_layout Description
6608 \begin_layout Description
6609 Origin Asger, 14 Feb 1997
6612 \begin_layout Subsection*
6616 \begin_layout Description
6617 Action Apply the given settings to user preferences.
6620 \begin_layout Description
6621 Syntax lyxrc-apply <SETTINGS>
6624 \begin_layout Description
6625 Params <SETTINGS>: settings which are to be set.
6626 Take a look into ~/.lyx/preferences to get an idea which commands to use
6628 lyx::LyXRC::LyXRCTags has the list of possible commands.
6631 \begin_layout Subsection*
6632 LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
6635 \begin_layout Description
6636 Action Determine whether keep cursor inside the editing window regardless
6637 the scrollbar movement.
6640 \begin_layout Description
6641 Syntax toggle-cursor-follows-scrollbar
6644 \begin_layout Description
6645 Origin ARRae, 2 Dec 1997
6648 \begin_layout Subsection*
6652 \begin_layout Description
6653 Action Set the given LyX color to the color defined by the X11 name given.
6656 \begin_layout Description
6657 Notion A new color entry is created if the color is unknown.
6658 Color names can be stored as a part of user settings.
6661 \begin_layout Description
6662 Syntax set-color <LYX_NAME> <X11_NAME>
6665 \begin_layout Description
6666 Origin SLior, 11 Jun 2000
6669 \begin_layout Subsection*
6673 \begin_layout Description
6674 Action Count the statistics (number of words and characters) in the document
6675 or in the given selection.
6678 \begin_layout Description
6679 Notion Note that this function gives the number of words/chars written,
6680 not the number of characters which will be typeset.
6683 \begin_layout Description
6687 \begin_layout Description
6688 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
6691 \begin_layout Subsection*
6692 LFUN_COMPLETION_INLINE
6695 \begin_layout Description
6696 Action Show the inline completion at the cursor position.
6699 \begin_layout Description
6700 Syntax completion-inline
6703 \begin_layout Description
6704 Origin sts, Feb 19 2008
6707 \begin_layout Subsection*
6708 LFUN_COMPLETION_POPUP
6711 \begin_layout Description
6712 Action Show the completion popup at the cursor position.
6715 \begin_layout Description
6716 Syntax completion-popup
6719 \begin_layout Description
6720 Origin sts, Feb 19 2008
6723 \begin_layout Subsection*
6724 LFUN_COMPLETION_COMPLETE
6727 \begin_layout Description
6728 Action Try to complete the word or command at the cursor position.
6731 \begin_layout Description
6735 \begin_layout Description
6736 Origin sts, Feb 19 2008
6739 \begin_layout Subsection*
6740 LFUN_COMPLETION_CANCEL
6743 \begin_layout Description
6744 Action Try to cancel completion, either the popup or the inline completion.
6747 \begin_layout Description
6748 Syntax completion-cancel
6751 \begin_layout Description
6752 Origin sts, Sep 07 2008
6755 \begin_layout Subsection*
6756 LFUN_COMPLETION_ACCEPT
6759 \begin_layout Description
6760 Action Accept suggested completion.
6763 \begin_layout Description
6764 Syntax completion-accept
6767 \begin_layout Description
6768 Origin sanda, Sep 08 2008
6771 \begin_layout Subsection*
6775 \begin_layout Description
6776 Action Add a branch to the buffer's BranchList.
6779 \begin_layout Description
6780 Syntax branch-add <BRANCH>
6783 \begin_layout Description
6784 Params <BRANCH>: Name of the branch to add
6787 \begin_layout Description
6788 Origin spitz, 7 Jul 2009
6791 \begin_layout Subsection*
6792 LFUN_BRANCH_ACTIVATE
6795 \begin_layout Description
6796 Action Activate the branch.
6799 \begin_layout Description
6800 Syntax branch-activate <BRANCH>
6803 \begin_layout Description
6804 Params <BRANCH>: The branch to activate
6807 \begin_layout Description
6808 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
6809 \begin_inset Newline newline
6812 could be used to export a pdf with the answers branch included without one's
6813 having to open LyX and activate the branch manually.
6816 \begin_layout Description
6817 Origin rgh, 27 May 2008
6820 \begin_layout Subsection*
6821 LFUN_BRANCH_DEACTIVATE
6824 \begin_layout Description
6825 Action De-activate the branch.
6828 \begin_layout Description
6829 Syntax branch-deactivate <BRANCH>
6832 \begin_layout Description
6833 Params <BRANCH>: The branch to deactivate
6836 \begin_layout Description
6837 Origin rgh, 27 May 2008
6840 \begin_layout Subsection*
6841 LFUN_BRANCHES_RENAME
6844 \begin_layout Description
6845 Action Rename all branches of a given name in a document.
6848 \begin_layout Description
6849 Syntax branches-rename <OLDNAME> <NEWNAME>
6852 \begin_layout Description
6853 Params <OLDNAME>: Current name of the branch to be renamed <NEWNAME>: New
6857 \begin_layout Description
6858 Origin spitz, 9 Jul 2009
6861 \begin_layout Subsection*
6862 LFUN_BRANCH_ADD_INSERT
6865 \begin_layout Description
6866 Action Create new branch and directly put the branch inset into the document.
6869 \begin_layout Description
6870 Syntax branch-add-insert [<NAME>]
6873 \begin_layout Description
6874 Params <NAME>: Branch name.
6875 If it is not specified, you will be asked.
6878 \begin_layout Description
6879 Origin sanda, 10 Jul 2009
6882 \begin_layout Subsection*
6883 LFUN_LABEL_COPY_AS_REF
6886 \begin_layout Description
6887 Action Copies the label at the cursor as a cross-reference to be pasted
6891 \begin_layout Description
6892 Syntax copy-label-as-reference <LABEL>
6895 \begin_layout Description
6896 Params <LABEL>: The label to copy (for multi-line math)
6899 \begin_layout Description
6900 Origin sts, 16 Nov 2008
6903 \begin_layout Subsection*
6904 LFUN_LABEL_INSERT_AS_REF
6907 \begin_layout Description
6908 Action Inserts the label as a cross-reference at the position of the cursor.
6911 \begin_layout Description
6912 Syntax label-insert-as-reference
6915 \begin_layout Description
6916 Origin vfr, 7 Apr 2009
6919 \begin_layout Subsection*
6923 \begin_layout Description
6924 Action Increases the zoom of the screen fonts.
6927 \begin_layout Description
6928 Syntax buffer-zoom-in [<ZOOM>]
6931 \begin_layout Description
6932 Params <ZOOM>: The zoom in %, the default is 20.
6935 \begin_layout Description
6936 Origin vfr, 30 Mar 2009
6939 \begin_layout Subsection*
6940 LFUN_BUFFER_ZOOM_OUT
6943 \begin_layout Description
6944 Action Decreases the zoom of the screen fonts.
6947 \begin_layout Description
6948 Syntax buffer-zoom-out [<ZOOM>]
6951 \begin_layout Description
6952 Params <ZOOM>: The zoom in %, the default is 20.
6955 \begin_layout Description
6956 Origin vfr, 30 Mar 2009
6959 \begin_layout Subsection*
6963 \begin_layout Description
6964 Action Copies the inset to the clipboard as a certain type.
6967 \begin_layout Description
6968 Notion Currently used only for InsetInfo where its content is copied as
6972 \begin_layout Description
6973 Syntax inset-copy-as
6976 \begin_layout Description
6977 Origin vfr, 18 Apr 2010