1 #LyX 1.6.5svn created this file. For more info see http://www.lyx.org/
6 \use_default_options false
11 \font_typewriter default
12 \font_default_family default
19 \paperfontsize default
28 \paperorientation portrait
35 \paragraph_separation indent
37 \quotes_language english
40 \paperpagestyle default
41 \tracking_changes false
49 \begin_layout Section*
50 LFUNs documentation automatically generated 2009-10-07
53 \begin_layout Standard
57 \begin_layout Plain Layout
67 \begin_inset VSpace 1cm
73 \begin_layout Subsection*
77 \begin_layout Description
78 Action Adds an acute accent to the next character typed.
81 \begin_layout Description
85 \begin_layout Subsection*
89 \begin_layout Description
90 Action Adds a breve accent to the next character typed.
93 \begin_layout Description
97 \begin_layout Subsection*
101 \begin_layout Description
102 Action Adds a caron to the next character typed.
105 \begin_layout Description
109 \begin_layout Subsection*
113 \begin_layout Description
114 Action Adds a cedilla to the next character typed.
117 \begin_layout Description
118 Syntax accent-cedilla
121 \begin_layout Subsection*
125 \begin_layout Description
126 Action Adds a circle accent to the next character typed.
129 \begin_layout Description
133 \begin_layout Subsection*
134 LFUN_ACCENT_CIRCUMFLEX
137 \begin_layout Description
138 Action Adds a circumflex to the next character typed.
141 \begin_layout Description
142 Syntax accent-circumflex
145 \begin_layout Subsection*
149 \begin_layout Description
150 Action Adds a dot accent to the next character typed.
153 \begin_layout Description
157 \begin_layout Subsection*
161 \begin_layout Description
162 Action Adds a grave accent to the next character typed.
165 \begin_layout Description
169 \begin_layout Subsection*
170 LFUN_ACCENT_HUNGARIAN_UMLAUT
173 \begin_layout Description
174 Action Adds a Hungarian umlaut to the next character typed.
177 \begin_layout Description
181 \begin_layout Subsection*
185 \begin_layout Description
186 Action Adds a macron to the next character typed.
189 \begin_layout Description
193 \begin_layout Subsection*
197 \begin_layout Description
198 Action Adds an ogonek accent to the next character typed.
201 \begin_layout Description
205 \begin_layout Subsection*
209 \begin_layout Description
210 Action Adds a tie over the next two character typed.
213 \begin_layout Description
214 Notion The following char will finish the tie.
217 \begin_layout Description
221 \begin_layout Subsection*
225 \begin_layout Description
226 Action Adds a tilde over the next character typed.
229 \begin_layout Description
233 \begin_layout Subsection*
237 \begin_layout Description
238 Action Adds an umlaut over the next character typed.
241 \begin_layout Description
245 \begin_layout Subsection*
249 \begin_layout Description
250 Action Adds a bar under the next character typed.
253 \begin_layout Description
254 Syntax accent-underbar
257 \begin_layout Subsection*
261 \begin_layout Description
262 Action Adds a dot under the next character typed.
265 \begin_layout Description
266 Syntax accent-underdot
269 \begin_layout Subsection*
273 \begin_layout Description
274 Action Inserts a caption inset.
277 \begin_layout Description
278 Syntax caption-insert
281 \begin_layout Description
282 Origin Lgb, 18 Jul 2000
285 \begin_layout Subsection*
289 \begin_layout Description
290 Action Inserts the current date.
293 \begin_layout Description
294 Syntax date-insert [<ARG>]
297 \begin_layout Description
298 Params <ARG>: Format of date.
299 The default value (%x) can be set in Preferences->Date format.
300 For possible formats see manual page of strftime function.
303 \begin_layout Description
304 Origin jdblair, 31 Jan 2000
307 \begin_layout Subsection*
311 \begin_layout Description
312 Action Inserts a footnote inset.
315 \begin_layout Description
316 Syntax footnote-insert
319 \begin_layout Description
320 Origin Jug, 7 Mar 2000
323 \begin_layout Subsection*
327 \begin_layout Description
328 Action Inserts an ERT inset.
331 \begin_layout Description
335 \begin_layout Description
336 Origin Jug, 18 Feb 2000
339 \begin_layout Subsection*
343 \begin_layout Description
344 Action Inserts a float inset.
347 \begin_layout Description
348 Syntax float-insert <TYPE>
351 \begin_layout Description
352 Params <TYPE>: type of float depends on the used textclass.
353 Usually "algorithm", "table", "figure" parameters can be given.
356 \begin_layout Description
357 Origin Lgb, 27 Jun 2000
360 \begin_layout Subsection*
361 LFUN_FLOAT_WIDE_INSERT
364 \begin_layout Description
365 Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
368 \begin_layout Description
369 Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
372 \begin_layout Description
373 Syntax float-wide-insert <TYPE>
376 \begin_layout Description
377 Params <TYPE>: type of float depends on the used textclass.
378 Usually "algorithm", "table", "figure" parameters can be given.
381 \begin_layout Description
382 Origin Lgb, 31 Oct 2001
385 \begin_layout Subsection*
386 LFUN_FLOAT_LIST_INSERT
389 \begin_layout Description
390 Action Inserts the list of floats in the document.
393 \begin_layout Description
394 Syntax float-list-insert <TYPE>
397 \begin_layout Description
398 Params <TYPE>: type of float depends on the used textclass.
399 Usually "algorithm", "table", "figure" parameters can be given.
402 \begin_layout Description
403 Origin Lgb, 3 May 2001
406 \begin_layout Subsection*
410 \begin_layout Description
411 Action Inserts floats wrapped by the text around.
414 \begin_layout Description
415 Syntax wrap-insert <TYPE>
418 \begin_layout Description
419 Params <TYPE>: table|figure
422 \begin_layout Description
423 Origin Dekel, 7 Apr 2002
426 \begin_layout Subsection*
430 \begin_layout Description
431 Action Inserts an optional-argument (short title) inset.
434 \begin_layout Description
435 Syntax optional-insert
438 \begin_layout Description
439 Origin vermeer, 12 Aug 2002
442 \begin_layout Subsection*
446 \begin_layout Description
447 Action Inserts a horizontal line.
450 \begin_layout Description
454 \begin_layout Description
455 Origin Andre, Oct 27 2003
458 \begin_layout Subsection*
462 \begin_layout Description
463 Action Inserts a new page.
466 \begin_layout Description
467 Syntax newpage-insert <ARG>
470 \begin_layout Description
471 Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
474 \begin_layout Description
475 Origin uwestoehr, 24 Nov 2007
478 \begin_layout Subsection*
479 LFUN_MARGINALNOTE_INSERT
482 \begin_layout Description
483 Action Inserts a marginal note.
486 \begin_layout Description
487 Syntax marginalnote-insert
490 \begin_layout Description
491 Origin Lgb, 26 Jun 2000
494 \begin_layout Subsection*
498 \begin_layout Description
499 Action Inserts a single unicode character.
502 \begin_layout Description
503 Syntax unicode-insert <CHAR>
506 \begin_layout Description
507 Params <CHAR>: The character to insert, given as its code point, in hexadecimal.
510 \begin_layout Description
511 Sample unicode-insert 0x0100
514 \begin_layout Description
515 Origin Lgb, 22 Oct 2006
518 \begin_layout Subsection*
522 \begin_layout Description
523 Action Inserts a new listings inset.
526 \begin_layout Description
527 Syntax listing-insert
530 \begin_layout Description
531 Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
534 \begin_layout Subsection*
538 \begin_layout Description
539 Action Insert a tab into a listings inset.
542 \begin_layout Description
543 Notion It also works on a selection.
546 \begin_layout Description
550 \begin_layout Description
551 Origin vfr, Sep 30 2008
554 \begin_layout Subsection*
558 \begin_layout Description
559 Action Delete a tab or up to an equivalent amount of spaces from a listings
563 \begin_layout Description
564 Notion It also works on a selection - it removes a tab or spaces from the
565 beginning of each line spanned by the selection.
566 This is useful if you want to indent/unindent multiple lines in one action.
569 \begin_layout Description
573 \begin_layout Description
574 Origin vfr, Sep 30 2008
577 \begin_layout Subsection*
581 \begin_layout Description
582 Action Inserts quotes according to the type and quote-language preference.
585 \begin_layout Description
586 Notion Currently English, Swedish, German, Polish, French, Danish quotes
590 \begin_layout Description
591 Syntax quote-insert [<TYPE>]
594 \begin_layout Description
595 Params <TYPE>: 'single' for single quotes, otherwise double quotes will
599 \begin_layout Subsection*
603 \begin_layout Description
604 Action Displays shortcuts, lyxrc, package and textclass availability and
605 menu information in a non-editable boxed InsetText.
608 \begin_layout Description
609 Notion Apart from lfun arguments you can use the following method:
610 \begin_inset Newline newline
614 input the type and argument of this inset, e.g.
615 "menu paste", in the work area.
616 \begin_inset Newline newline
620 select the text and run info-insert lfun.
623 \begin_layout Description
624 Syntax info-insert <TYPE> <ARG>
627 \begin_layout Description
628 Params <TYPE>: shortcut[s]|lyxrc|package|textclass|menu|buffer
629 \begin_inset Newline newline
632 <ARG>: argument for a given type.
633 Look into InsetInfo.h for detailed description.
634 \begin_inset Newline newline
637 shortcut[s]: name of lfun (e.g math-insert
640 \begin_inset Newline newline
643 lyxrc: name of rc_entry (e.g.
645 \begin_inset Newline newline
648 package: name of latex package (e.g.
650 \begin_inset Newline newline
653 textclass: name of textclass (e.g.
655 \begin_inset Newline newline
658 menu: name of lfun used in menu
659 \begin_inset Newline newline
662 icon: name of lfun used in toolbar
663 \begin_inset Newline newline
666 buffer: "name"|"path"|"class"
669 \begin_layout Description
670 Sample command-sequence info-insert buffer path; info-insert buffer name
673 \begin_layout Description
674 Origin bpeng, 7 Oct 2007
677 \begin_layout Subsection*
681 \begin_layout Description
682 Action Inserts branch inset.
685 \begin_layout Description
686 Syntax branch-insert <BRANCH-NAME>
689 \begin_layout Description
690 Origin vermeer, 17 Aug 2003
693 \begin_layout Subsection*
697 \begin_layout Description
698 Action Inserts Box inset.
701 \begin_layout Description
702 Syntax box-insert [<TYPE>]
705 \begin_layout Description
706 Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
707 \begin_inset Newline newline
710 Framed is the default one.
713 \begin_layout Description
714 Origin vermeer, 7 Oct 2003
717 \begin_layout Subsection*
721 \begin_layout Description
722 Action Inserts CharStyle, Custom inset or XML short element.
725 \begin_layout Description
726 Notion Look into the Customization manual for more information about these
728 \begin_inset Newline newline
731 To make this command enabled the layout file for the document class you're
732 using has to load the character styles.
733 There are a few contained in the Logical Markup module.
734 You can also of course create some yourself.
735 \begin_inset Newline newline
738 For dissolving the element see LFUN_INSET_DISSOLVE.
741 \begin_layout Description
742 Syntax flex-insert <TYPE:Name>
745 \begin_layout Description
746 Params TYPE: CharStyle|Custom|Element|Standard
747 \begin_inset Newline newline
750 Identifies whether this is a Character Style, a Custom Inset or an XML Element,
751 and which dynamical sub-menu this flex inset is in on the LyX menu tree.
752 If Standard (currently unused): none of these.
753 \begin_inset Newline newline
756 Name: This name must be defined either in your layout file or imported by
758 The definition is InsetLayout <TYPE:Name>
761 \begin_layout Description
762 Sample flex-insert CharStyle:Code
765 \begin_layout Subsection*
769 \begin_layout Description
770 Action Inserts the given string (accordingly to the correct keymap).
773 \begin_layout Description
774 Notion Automatically replace the currently selected text.
775 Depends on lyxrc settings "auto_region_delete".
778 \begin_layout Description
779 Syntax self-insert <STRING>
782 \begin_layout Subsection*
786 \begin_layout Description
787 Action Inserts one of horizontal space insets.
790 \begin_layout Description
791 Syntax space-insert <NAME> [<LEN>]
794 \begin_layout Description
795 Params <NAME>: normal, protected, thin, quad, qquad, enspace, enskip, negthinspa
796 ce, hfill, hfill*, dotfill, hrulefill, hspace, hspace*
797 \begin_inset Newline newline
800 <LEN>: length for custom spaces (hspace, hspace* for protected)
803 \begin_layout Description
804 Origin JSpitzm, 20 May 2003, Mar 17 2008
807 \begin_layout Subsection*
808 LFUN_HYPERLINK_INSERT
811 \begin_layout Description
812 Action Inserts hyperlinks into the document (clickable in pdf output).
815 \begin_layout Description
816 Notion Hyperlink target can be set via selection + hyperlink-insert function.
819 \begin_layout Description
820 Syntax href-insert [<TARGET>]
823 \begin_layout Description
824 Origin CFO-G, 21 Nov 1997
827 \begin_layout Subsection*
828 LFUN_SPECIALCHAR_INSERT
831 \begin_layout Description
832 Action Inserts various characters into the document.
835 \begin_layout Description
836 Syntax specialchar-insert <CHAR>
839 \begin_layout Description
840 Params <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots, end-of-sen
841 tence, menu-separator.
844 \begin_layout Description
845 Origin JSpitzm, 6 Dec 2007
848 \begin_layout Subsection*
852 \begin_layout Description
853 Action Inserts table of contents.
856 \begin_layout Description
860 \begin_layout Description
861 Origin Lgb, 27 May 97
864 \begin_layout Subsection*
868 \begin_layout Description
869 Action Start (or remove) Appendix on the given cursor position.
872 \begin_layout Description
876 \begin_layout Description
877 Origin ettrich, 5 May 1998
880 \begin_layout Subsection*
884 \begin_layout Description
885 Action Inserts Index entry.
888 \begin_layout Description
889 Notion It automatically takes the word on the cursor position.
892 \begin_layout Description
893 Syntax index-insert [<TYPE:Name>]
896 \begin_layout Description
897 Params <TYPE:Name>: name of the index, if multiple indices are defined.
898 with an empty argument, the default index is selected.
901 \begin_layout Description
902 Origin leeming, 3 Aug 2000
905 \begin_layout Subsection*
909 \begin_layout Description
910 Action Inserts list of Index entries on a new page.
913 \begin_layout Description
914 Syntax index-print [<TYPE:Name>]
917 \begin_layout Description
918 Params <TYPE:Name>: name of the index, if multiple indices are defined.
919 with an empty argument, the default index is selected.
922 \begin_layout Description
923 Origin Lgb, 27 Feb 1997
926 \begin_layout Subsection*
930 \begin_layout Description
931 Action Inserts Nomenclature entry.
934 \begin_layout Description
935 Notion It automatically takes the word on the cursor position if no symbol
939 \begin_layout Description
940 Syntax nomencl-insert [<SYMBOL>]
943 \begin_layout Description
944 Origin Ugras, 4 Nov 2006
947 \begin_layout Subsection*
948 LFUN_NOMENCLATURE_PRINT
951 \begin_layout Description
952 Action Inserts list of Nomenclature entries.
955 \begin_layout Description
956 Syntax nomenclature-print
959 \begin_layout Description
960 Origin Ugras, 4 Nov 2006
963 \begin_layout Subsection*
967 \begin_layout Description
968 Action Inserts Note on the current cursor postion, move selection inside
972 \begin_layout Description
973 Syntax note-insert [<TYPE>]
976 \begin_layout Description
977 Params <TYPE>: <Note|Greyedout|Comment> default: Note
980 \begin_layout Subsection*
984 \begin_layout Description
985 Action Moves the cursor to the begining of next Note inset.
988 \begin_layout Description
992 \begin_layout Subsection*
996 \begin_layout Description
997 Action Changes all Note insets of a particular type (source) to a different
998 type (target) fot the current document.
1001 \begin_layout Description
1002 Syntax notes-mutate <SOURCE> <TARGET>
1005 \begin_layout Description
1006 Params <SOURCE/TARGET>: Note|Comment|Greyedout
1009 \begin_layout Description
1010 Origin sanda, 18 Jun 2008
1013 \begin_layout Subsection*
1017 \begin_layout Description
1018 Action Inserts phantom on the current cursor postion, move selection inside
1022 \begin_layout Description
1023 Syntax phantom-insert [<TYPE>]
1026 \begin_layout Description
1027 Params <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
1030 \begin_layout Description
1031 Origin uwestoehr, 30 Jan 2009
1034 \begin_layout Subsection*
1038 \begin_layout Description
1039 Action Inserts a line break or new line.
1042 \begin_layout Description
1043 Syntax newline-insert [<ARG>]
1046 \begin_layout Description
1047 Params <ARG>: <newline|linebreak> default: newline
1050 \begin_layout Description
1051 Origin JSpitzm, 25 Mar 2008
1054 \begin_layout Subsection*
1058 \begin_layout Description
1059 Action Clears the selection.
1060 If no text is selected call LFUN_FINISHED_FORWARD.
1063 \begin_layout Description
1067 \begin_layout Description
1068 Origin Lgb, 17 May 2001
1071 \begin_layout Subsection*
1075 \begin_layout Description
1076 Action Moves the cursor one line in downward direction.
1079 \begin_layout Description
1083 \begin_layout Subsection*
1087 \begin_layout Description
1088 Action Moves the cursor one line in upward direction.
1091 \begin_layout Description
1095 \begin_layout Subsection*
1099 \begin_layout Description
1100 Action Moves the cursor one line in downward direction adding the current
1101 position to the selection.
1104 \begin_layout Description
1108 \begin_layout Subsection*
1112 \begin_layout Description
1113 Action Moves the cursor one line in upward direction adding the current
1114 position to the selection.
1117 \begin_layout Description
1121 \begin_layout Subsection*
1125 \begin_layout Description
1126 Action Moves the cursor one page in downward direction.
1129 \begin_layout Description
1133 \begin_layout Subsection*
1137 \begin_layout Description
1138 Action Moves the cursor one page in upward direction.
1141 \begin_layout Description
1145 \begin_layout Subsection*
1146 LFUN_SCREEN_DOWN_SELECT
1149 \begin_layout Description
1150 Action Moves the cursor one screen in downward direction adding the current
1151 position to the selection.
1154 \begin_layout Description
1155 Syntax screen-down-select
1158 \begin_layout Subsection*
1159 LFUN_SCREEN_UP_SELECT
1162 \begin_layout Description
1163 Action Moves the cursor one page in upward direction adding the current
1164 position to the selection.
1167 \begin_layout Description
1168 Syntax screen-up-select
1171 \begin_layout Subsection*
1175 \begin_layout Description
1176 Action Scroll the buffer view.
1179 \begin_layout Description
1180 Notion Only scrolls the screen up or down; does not move the cursor.
1183 \begin_layout Description
1184 Syntax scroll <TYPE> <QUANTITY>
1187 \begin_layout Description
1188 Params <TYPE>: line|page
1189 \begin_inset Newline newline
1192 <QUANTITY>: up|down|<number>
1195 \begin_layout Description
1196 Origin Abdel, Dec 27 2007
1199 \begin_layout Subsection*
1200 LFUN_SCREEN_RECENTER
1203 \begin_layout Description
1204 Action Recenters the screen on the current cursor position.
1207 \begin_layout Description
1208 Syntax screen-recenter
1211 \begin_layout Subsection*
1212 LFUN_SCREEN_SHOW_CURSOR
1215 \begin_layout Description
1216 Action Repositions the screen such that the cursor is visible.
1219 \begin_layout Description
1220 Syntax screen-show-cursor
1223 \begin_layout Description
1224 Origin vfr, 25 Mar 2009
1227 \begin_layout Subsection*
1231 \begin_layout Description
1232 Action Moves the cursor one position logically backwards.
1235 \begin_layout Description
1236 Notion This is not the action which should be bound to the arrow keys, because
1237 backwards may be left or right, depending on the language.
1238 The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions,
1239 which in turn may employ this one.
1242 \begin_layout Description
1243 Syntax char-backward
1246 \begin_layout Subsection*
1247 LFUN_CHAR_BACKWARD_SELECT
1250 \begin_layout Description
1251 Action Moves the cursor one position logically backwards, adding traversed
1252 position to the selection.
1255 \begin_layout Description
1256 Notion See also LFUN_CHAR_BACKWARD.
1259 \begin_layout Description
1260 Syntax char-backward-select
1263 \begin_layout Subsection*
1264 LFUN_CHAR_DELETE_BACKWARD
1267 \begin_layout Description
1268 Action Deletes one character in the backward direction (usually the "BackSpace"
1272 \begin_layout Description
1273 Syntax char-delete-backward
1276 \begin_layout Subsection*
1277 LFUN_CHAR_DELETE_FORWARD
1280 \begin_layout Description
1281 Action Deletes one character in the backward direction (usually the "Delete"
1285 \begin_layout Description
1286 Syntax char-delete-forward
1289 \begin_layout Subsection*
1293 \begin_layout Description
1294 Action Moves the cursor one position logically forward.
1297 \begin_layout Description
1298 Notion This is not the action which should be bound to the arrow keys, because
1299 forward may be left or right, depending on the language.
1300 The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions,
1301 which in turn may employ this one.
1304 \begin_layout Description
1308 \begin_layout Subsection*
1309 LFUN_CHAR_FORWARD_SELECT
1312 \begin_layout Description
1313 Action Moves the cursor one position logically forward, adding traversed
1314 position to the selection.
1317 \begin_layout Description
1318 Notion See also LFUN_CHAR_FORWARD.
1321 \begin_layout Description
1322 Syntax char-forward-select
1325 \begin_layout Subsection*
1329 \begin_layout Description
1330 Action Moves the cursor one position "to the left".
1333 \begin_layout Description
1334 Notion This is the action which should be taken when the "left" key is pressed.
1335 Generally, it moves the cursor one position to the left.
1336 However, in Bidi text this become slightly more complicated, and there
1337 are different modes of cursor movement.
1338 In "visual mode", this moves left, plain and simple.
1339 In "logical mode", movement is logically forward in RTL paragraphs, and
1340 logically backwards in LTR paragraphs.
1343 \begin_layout Description
1347 \begin_layout Subsection*
1348 LFUN_CHAR_LEFT_SELECT
1351 \begin_layout Description
1352 Action Moves the cursor one position "to the left", adding traversed position
1356 \begin_layout Description
1357 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1360 \begin_layout Description
1361 Syntax char-left-select
1364 \begin_layout Subsection*
1368 \begin_layout Description
1369 Action Moves the cursor one position "to the right".
1372 \begin_layout Description
1373 Notion This is the action which should be taken when the "right" key is
1375 Generally, it moves the cursor one position to the right.
1376 However, in Bidi text this become slightly more complicated, and there
1377 are different modes of cursor movement.
1378 In "visual mode", this moves right, plain and simple.
1379 In "logical mode", movement is logically forward in LTR paragraphs, and
1380 logically backwards in RTL paragraphs.
1383 \begin_layout Description
1387 \begin_layout Subsection*
1388 LFUN_CHAR_RIGHT_SELECT
1391 \begin_layout Description
1392 Action Moves the cursor one position "to the right", adding traversed position
1396 \begin_layout Description
1397 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1400 \begin_layout Description
1401 Syntax char-right-select
1404 \begin_layout Subsection*
1408 \begin_layout Description
1409 Action Moves the cursor to the logically previous beginning of a word.
1412 \begin_layout Description
1413 Notion This is not the action which should be bound to the arrow keys, because
1414 backwards may be left or right, depending on the language.
1415 The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
1416 which in turn may employ this one.
1419 \begin_layout Description
1420 Syntax word-backward
1423 \begin_layout Subsection*
1424 LFUN_WORD_BACKWARD_SELECT
1427 \begin_layout Description
1428 Action Moves the cursor to the logically previous beginning of a word, adding
1429 the logically traversed text to the selection.
1432 \begin_layout Description
1433 Notion See also LFUN_WORD_BACKWARD.
1436 \begin_layout Description
1437 Syntax word-backward-select
1440 \begin_layout Subsection*
1441 LFUN_WORD_DELETE_BACKWARD
1444 \begin_layout Description
1445 Action Deletes characters to the begining of the word (usually the "C+BackSpace"
1449 \begin_layout Description
1450 Syntax word-delete-backward
1453 \begin_layout Subsection*
1454 LFUN_WORD_DELETE_FORWARD
1457 \begin_layout Description
1458 Action Deletes characters to the end of the word (usually the "C+Delete"
1462 \begin_layout Description
1463 Syntax word-delete-forward
1466 \begin_layout Subsection*
1467 LFUN_WORD_FIND_FORWARD
1470 \begin_layout Description
1471 Action Search for a given string in forward direction.
1474 \begin_layout Description
1475 Notion Case sensitive, match words.
1476 If no argument given, last search repeated.
1479 \begin_layout Description
1480 Syntax word-find-forward [<STRING>]
1483 \begin_layout Description
1484 Origin Etienne, 16 Feb 1998
1487 \begin_layout Subsection*
1488 LFUN_WORD_FIND_BACKWARD
1491 \begin_layout Description
1492 Action Search for a given string in backward direction.
1495 \begin_layout Description
1496 Notion Case sensitive, match words.
1497 If no argument given, last search repeated.
1500 \begin_layout Description
1501 Syntax word-find-backward [<STRING>]
1504 \begin_layout Description
1505 Origin Etienne, 20 Feb 1998
1508 \begin_layout Subsection*
1512 \begin_layout Description
1513 Action Search for next occurence of a string.
1516 \begin_layout Description
1517 Syntax word-find [<DATA>]
1520 \begin_layout Description
1521 Params <DATA>: data encoded from Find dialog (see lyx::find2string()).
1522 If no parameter is given, search with last find-dialog data is used for
1527 \begin_layout Description
1528 Origin Andre, Jan 7 2004
1531 \begin_layout Subsection*
1535 \begin_layout Description
1536 Action Replace a string in the document.
1539 \begin_layout Description
1540 Syntax word-replace [<DATA>]
1543 \begin_layout Description
1544 Params <DATA>: data is of the form "<replace>
1545 \begin_inset Newline newline
1549 \begin_inset Newline newline
1552 <casesensitive> <matchword> <all> <forward>"
1555 \begin_layout Description
1556 Origin Andre, Jan 7 2004
1559 \begin_layout Subsection*
1563 \begin_layout Description
1564 Action Search for next occurence of a pattern.
1567 \begin_layout Description
1568 Syntax word-findadv [<DATA>]
1571 \begin_layout Description
1572 Params <DATA>: data encoded from FindAdv dialog (see lyx::findadv2string()).
1573 If no parameter is given, search with last find-dialog data is used for
1578 \begin_layout Description
1579 Origin Tommaso, Nov 15 2007
1582 \begin_layout Subsection*
1586 \begin_layout Description
1587 Action Moves the cursor to the logically next beginning of a word.
1590 \begin_layout Description
1591 Notion This is not the action which should be bound to the arrow keys, because
1592 forward may be left or right, depending on the language.
1593 The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
1594 which in turn may employ this one.
1597 \begin_layout Description
1601 \begin_layout Subsection*
1602 LFUN_WORD_FORWARD_SELECT
1605 \begin_layout Description
1606 Action Moves the cursor to the logically next beginning of a word, adding
1607 the logically traversed text to the selection.
1610 \begin_layout Description
1611 Notion See also LFUN_WORD_FORWARD.
1614 \begin_layout Description
1615 Syntax word-forward-select
1618 \begin_layout Subsection*
1622 \begin_layout Description
1623 Action Moves the cursor to the next beginning of a word "on the left".
1626 \begin_layout Description
1627 Notion This is the action which should be taken when the (e.g., ctrl-) "left"
1629 Generally, it moves the cursor to the next beginning of a word on the left.
1630 However, in Bidi text this become slightly more complicated, and there
1631 are different modes of cursor movement.
1632 In "visual mode", this moves left, plain and simple.
1633 In "logical mode", movement is logically forward in RTL paragraphs, and
1634 logically backwards in LTR paragraphs.
1637 \begin_layout Description
1641 \begin_layout Description
1642 Origin dov, 28 Oct 2007
1645 \begin_layout Subsection*
1646 LFUN_WORD_LEFT_SELECT
1649 \begin_layout Description
1650 Action Moves the cursor to the next beginning of a word "on the left", adding
1651 *logically* traversed text to the selection.
1654 \begin_layout Description
1655 Notion See also LFUN_WORD_LEFT for exact details of the movement.
1658 \begin_layout Description
1659 Syntax word-left-select
1662 \begin_layout Description
1663 Origin dov, 28 Oct 2007
1666 \begin_layout Subsection*
1670 \begin_layout Description
1671 Action Moves the cursor to the next beginning of a word "on the right".
1674 \begin_layout Description
1675 Notion This is the action which should be taken when the (e.g., ctrl-) "right"
1677 Generally, it moves the cursor to the next beginning of a word on the right.
1678 However, in Bidi text this become slightly more complicated, and there
1679 are different modes of cursor movement.
1680 In "visual mode", this moves right, plain and simple.
1681 In "logical mode", movement is logically forward in LTR paragraphs, and
1682 logically backwards in RTL paragraphs.
1685 \begin_layout Description
1689 \begin_layout Description
1690 Origin dov, 28 Oct 2007
1693 \begin_layout Subsection*
1694 LFUN_WORD_RIGHT_SELECT
1697 \begin_layout Description
1698 Action Moves the cursor to the next beginning of a word "on the right",
1699 adding *logically* traversed text to the selection.
1702 \begin_layout Description
1703 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
1706 \begin_layout Description
1707 Syntax word-right-select
1710 \begin_layout Description
1711 Origin dov, 28 Oct 2007
1714 \begin_layout Subsection*
1718 \begin_layout Description
1719 Action Puts the word where the cursor stands into the selection.
1722 \begin_layout Description
1726 \begin_layout Description
1727 Origin Andre, 11 Sep 2002
1730 \begin_layout Subsection*
1731 LFUN_WORD_CAPITALIZE
1734 \begin_layout Description
1735 Action Capitalizes the words in the selection (i.e.
1736 the first letters) or the letter on the cursor position.
1739 \begin_layout Description
1740 Syntax word-capitalize
1743 \begin_layout Subsection*
1747 \begin_layout Description
1748 Action Change the words in the selection or from the cursor position to
1749 the end of word to the upper case.
1752 \begin_layout Description
1756 \begin_layout Subsection*
1760 \begin_layout Description
1761 Action Change the words in the selection or from the cursor position to
1762 the end of word to the lower case.
1765 \begin_layout Description
1769 \begin_layout Subsection*
1770 LFUN_THESAURUS_ENTRY
1773 \begin_layout Description
1774 Action Look up thesaurus entries with respect to the word under the cursor.
1777 \begin_layout Description
1778 Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
1781 \begin_layout Description
1782 Params <STRING>: word to look up <LANG>: language (see file languages)
1785 \begin_layout Description
1786 Origin Levon, 20 Jul 2001
1789 \begin_layout Subsection*
1793 \begin_layout Description
1794 Action Move the cursor to the beginning of the document.
1797 \begin_layout Description
1801 \begin_layout Subsection*
1802 LFUN_BUFFER_BEGIN_SELECT
1805 \begin_layout Description
1806 Action Move the cursor to the beginning of the document adding the traversed
1807 text to the selection.
1810 \begin_layout Description
1811 Syntax buffer-begin-select
1814 \begin_layout Subsection*
1818 \begin_layout Description
1819 Action Move the cursor to the end of the document.
1822 \begin_layout Description
1826 \begin_layout Subsection*
1827 LFUN_BUFFER_END_SELECT
1830 \begin_layout Description
1831 Action Move the cursor to the end of the document adding the traversed text
1835 \begin_layout Description
1836 Syntax buffer-end-select
1839 \begin_layout Subsection*
1843 \begin_layout Description
1844 Action Move the cursor to the beginning of the current inset if it is not
1845 already there, or at the beginning of the enclosing inset otherwise
1848 \begin_layout Description
1852 \begin_layout Description
1853 Origin lasgouttes, 16 Mar 2009
1856 \begin_layout Subsection*
1857 LFUN_INSET_BEGIN_SELECT
1860 \begin_layout Description
1861 Action Move the cursor to the beginning of the current inset if it is not
1862 already there, or at the beginning of the enclosing inset otherwise (adding
1863 the traversed text to the selection).
1866 \begin_layout Description
1867 Syntax inset-begin-select
1870 \begin_layout Description
1871 Origin lasgouttes, 16 Mar 2009
1874 \begin_layout Subsection*
1878 \begin_layout Description
1879 Action Move the cursor to the end of the current inset if it is not already
1880 there, or at the end of the enclosing inset otherwise
1883 \begin_layout Description
1887 \begin_layout Description
1888 Origin lasgouttes, 16 Mar 2009
1891 \begin_layout Subsection*
1892 LFUN_INSET_END_SELECT
1895 \begin_layout Description
1896 Action Move the cursor to the end of the current inset if it is not already
1897 there, or at the end of the enclosing inset otherwise (adding the traversed
1898 text to the selection).
1901 \begin_layout Description
1902 Syntax inset-end-select
1905 \begin_layout Description
1906 Origin lasgouttes, 16 Mar 2009
1909 \begin_layout Subsection*
1910 LFUN_INSET_SELECT_ALL
1913 \begin_layout Description
1914 Action Selects all contents of an inset.
1917 \begin_layout Description
1918 Syntax inset-select-all
1921 \begin_layout Description
1922 Origin vfr, 22 Aug 2009
1925 \begin_layout Subsection*
1929 \begin_layout Description
1930 Action Move the cursor to the begining of the (screen) line.
1933 \begin_layout Description
1937 \begin_layout Subsection*
1938 LFUN_LINE_BEGIN_SELECT
1941 \begin_layout Description
1942 Action Move the cursor to the beginning of the (screen) line adding the
1943 traversed text to the selection.
1946 \begin_layout Description
1947 Syntax line-begin-select
1950 \begin_layout Subsection*
1954 \begin_layout Description
1955 Action Move the cursor to the end of the (screen) line.
1958 \begin_layout Description
1962 \begin_layout Subsection*
1963 LFUN_LINE_END_SELECT
1966 \begin_layout Description
1967 Action Move the cursor to the end of the (screen) line adding the traversed
1968 text to the selection.
1971 \begin_layout Description
1972 Syntax line-end-select
1975 \begin_layout Subsection*
1979 \begin_layout Description
1980 Action Deletes the letters to the end of the (screen) line or deletes the
1984 \begin_layout Description
1985 Syntax line-delete-forward
1988 \begin_layout Subsection*
1992 \begin_layout Description
1993 Action Copies to the clipboard the last edit.
1996 \begin_layout Description
2000 \begin_layout Subsection*
2004 \begin_layout Description
2005 Action Cuts to the clipboard.
2008 \begin_layout Description
2012 \begin_layout Subsection*
2016 \begin_layout Description
2017 Action Pastes material (text or picture) from the active clipboard.
2020 \begin_layout Description
2021 Syntax paste [<TYPE>|<NUM>]
2024 \begin_layout Description
2025 Params <TYPE>: emf|pdf|png|jpeg|linkback|wmf
2026 \begin_inset Newline newline
2029 <NUM>: number of the selection in the internal clipboard stack to be pasted.
2032 \begin_layout Subsection*
2033 LFUN_CLIPBOARD_PASTE
2036 \begin_layout Description
2037 Action Pastes text from the active clipboard.
2040 \begin_layout Description
2041 Syntax clipboard-paste [<ARG>]
2044 \begin_layout Description
2045 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
2049 \begin_layout Description
2050 Origin baum, 10 Jul 2006
2053 \begin_layout Subsection*
2054 LFUN_PRIMARY_SELECTION_PASTE
2057 \begin_layout Description
2058 Action Pastes the currently text selected text.
2061 \begin_layout Description
2062 Notion Primary selection mechanism is linux-only thing.
2065 \begin_layout Description
2066 Syntax primary-selection-paste [<ARG>]
2069 \begin_layout Description
2070 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
2074 \begin_layout Subsection*
2075 LFUN_SELECTION_PASTE
2078 \begin_layout Description
2079 Action Pastes the text in permanent selection.
2082 \begin_layout Description
2083 Syntax selection-paste
2086 \begin_layout Subsection*
2090 \begin_layout Description
2091 Action Undoes the last edit.
2094 \begin_layout Description
2098 \begin_layout Subsection*
2102 \begin_layout Description
2103 Action Redoes the last thing undone.
2106 \begin_layout Description
2110 \begin_layout Subsection*
2114 \begin_layout Description
2115 Action Repeat the given command.
2118 \begin_layout Description
2119 Syntax repeat <COUNT> <LFUN-COMMAND>
2122 \begin_layout Description
2123 Origin Andre, 27 Oct 2003
2126 \begin_layout Subsection*
2127 LFUN_CHARS_TRANSPOSE
2130 \begin_layout Description
2131 Action Transposes the character at the cursor with the one before it.
2134 \begin_layout Description
2135 Syntax chars-transpose
2138 \begin_layout Description
2139 Origin Lgb, 25 Apr 2001
2142 \begin_layout Subsection*
2143 LFUN_DEPTH_DECREMENT
2146 \begin_layout Description
2147 Action Decrease the nesting depth of the (selected) paragraph(s) inside
2151 \begin_layout Description
2152 Syntax depth-decrement
2155 \begin_layout Subsection*
2156 LFUN_DEPTH_INCREMENT
2159 \begin_layout Description
2160 Action Increase the nesting depth of the (selected) paragraph(s) inside
2164 \begin_layout Description
2165 Syntax depth-increment
2168 \begin_layout Subsection*
2172 \begin_layout Description
2173 Action Toggles the bold font (selection-wise) using mathbf in math.
2176 \begin_layout Description
2180 \begin_layout Subsection*
2181 LFUN_FONT_BOLDSYMBOL
2184 \begin_layout Description
2185 Action Toggles the bold font (selection-wise) using boldsymbol in math.
2188 \begin_layout Description
2189 Syntax font-boldsymbol
2192 \begin_layout Subsection*
2193 LFUN_FONT_TYPEWRITER
2196 \begin_layout Description
2197 Action Toggles the typewriter family font (selection-wise).
2200 \begin_layout Description
2201 Syntax font-typewriter
2204 \begin_layout Subsection*
2208 \begin_layout Description
2209 Action Toggles underline in the font (selection-wise).
2212 \begin_layout Description
2213 Syntax font-underline
2216 \begin_layout Subsection*
2220 \begin_layout Description
2221 Action Toggles double underline in the font (selection-wise).
2224 \begin_layout Description
2225 Syntax font-underunderline
2228 \begin_layout Description
2229 Origin sanda, 5 May 2009
2232 \begin_layout Subsection*
2236 \begin_layout Description
2237 Action Toggles wavy underline in the font (selection-wise).
2240 \begin_layout Description
2241 Syntax font-underwave
2244 \begin_layout Description
2245 Origin sanda, 5 May 2009
2248 \begin_layout Subsection*
2252 \begin_layout Description
2253 Action Toggles strikeout (strike-through) in the font (selection-wise).
2256 \begin_layout Description
2257 Syntax font-strikeout
2260 \begin_layout Description
2261 Origin sanda, 3 May 2009
2264 \begin_layout Subsection*
2268 \begin_layout Description
2269 Action Toggles the emphasis font style (selection-wise).
2272 \begin_layout Description
2276 \begin_layout Subsection*
2280 \begin_layout Description
2281 Action Toggles Noun text style font (selection-wise).
2284 \begin_layout Description
2288 \begin_layout Subsection*
2292 \begin_layout Description
2293 Action Toggles Roman family font (selection-wise).
2296 \begin_layout Description
2300 \begin_layout Subsection*
2304 \begin_layout Description
2305 Action Toggles Sans Serif family font (selection-wise).
2308 \begin_layout Description
2312 \begin_layout Subsection*
2316 \begin_layout Description
2317 Action Toggles Fraktur family font (math-mode, selection-wise).
2320 \begin_layout Description
2324 \begin_layout Description
2325 Origin vermeer, 10 Jan 2002
2328 \begin_layout Subsection*
2332 \begin_layout Description
2333 Action Toggles Italics font shape (math-mode, selection-wise).
2336 \begin_layout Description
2340 \begin_layout Description
2341 Origin vermeer, 10 Jan 2002
2344 \begin_layout Subsection*
2348 \begin_layout Description
2349 Action Reverts the settings of the font to the default values (selection-wise).
2352 \begin_layout Description
2356 \begin_layout Subsection*
2360 \begin_layout Description
2361 Action Sets font size according to lyx format string.
2364 \begin_layout Description
2365 Syntax font-size <SIZE>
2368 \begin_layout Description
2369 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
2370 \begin_inset Newline newline
2373 largest|huge|giant|increase|decrease|default
2376 \begin_layout Subsection*
2377 LFUN_TEXTSTYLE_APPLY
2380 \begin_layout Description
2381 Action Toggle user-defined (=last-time used) text style.
2384 \begin_layout Description
2385 Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically
2386 trigerred when using Text Style dialog.
2389 \begin_layout Description
2390 Syntax textstyle-apply
2393 \begin_layout Description
2394 Origin leeming, 12 Mar 2003
2397 \begin_layout Subsection*
2398 LFUN_TEXTSTYLE_UPDATE
2401 \begin_layout Description
2402 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APP
2406 \begin_layout Description
2407 Syntax textstyle-update <FONT_INFO>
2410 \begin_layout Description
2411 Params <FONT_INFO>: specifies font atributes, e.g.
2412 family, series, shape, size, emph, noun, underbar, number, color, language,
2414 \begin_inset Newline newline
2417 Use lyx -dbg action for exact syntax of text-style dialog parameters.
2420 \begin_layout Description
2421 Origin leeming, 12 Mar 2003
2424 \begin_layout Subsection*
2425 LFUN_SCREEN_FONT_UPDATE
2428 \begin_layout Description
2429 Action Update fonts and its metrics.
2432 \begin_layout Description
2433 Notion Automatically called after zoom, dpi, font names, or norm change.
2436 \begin_layout Description
2437 Syntax screen-font-update
2440 \begin_layout Description
2441 Origin ARRae, 13 Aug 2000
2444 \begin_layout Subsection*
2448 \begin_layout Description
2449 Action Returns the info about the current font.
2452 \begin_layout Description
2456 \begin_layout Subsection*
2457 LFUN_CITATION_INSERT
2460 \begin_layout Description
2461 Action Inserts citation from loaded citation database.
2464 \begin_layout Description
2465 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
2468 \begin_layout Description
2469 Params <KEY>: Citation (shortcut listed in available citations).
2470 \begin_inset Newline newline
2473 <TEXT_BEFORE>: text which should appear before citation.
2476 \begin_layout Description
2477 Origin AAS, 97-02-23
2480 \begin_layout Subsection*
2481 LFUN_BIBTEX_DATABASE_ADD
2484 \begin_layout Description
2485 Action Adds database, which will be used for bibtex citations.
2488 \begin_layout Description
2489 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX
2490 bibliography) found from the cursor postion.
2493 \begin_layout Description
2494 Syntax bibtex-database-add <DATABASE-NAME>
2497 \begin_layout Description
2498 Origin Ale, 30 May 1997
2501 \begin_layout Subsection*
2502 LFUN_BIBTEX_DATABASE_DEL
2505 \begin_layout Description
2506 Action Adds database, which will be used for bibtex citations.
2509 \begin_layout Description
2510 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTe
2511 X bibliography) found from the cursor postion.
2514 \begin_layout Description
2515 Syntax bibtex-database-del <DATABASE-NAME>
2518 \begin_layout Description
2519 Origin Ale, 30 May 1997
2522 \begin_layout Subsection*
2526 \begin_layout Description
2527 Action Sets the layout (that is, environment) for the current paragraph.
2530 \begin_layout Description
2531 Syntax layout <LAYOUT>
2534 \begin_layout Description
2535 Params <LAYOUT>: the layout to use
2538 \begin_layout Subsection*
2539 LFUN_LAYOUT_PARAGRAPH
2542 \begin_layout Description
2543 Action Launches the paragraph settings dialog.
2546 \begin_layout Description
2547 Syntax layout-paragraph
2550 \begin_layout Subsection*
2554 \begin_layout Description
2555 Action Launches the tabular settings dialog.
2558 \begin_layout Description
2559 Syntax layout-tabular
2562 \begin_layout Description
2563 Origin Jug, 31 Jul 2000
2566 \begin_layout Subsection*
2567 LFUN_DROP_LAYOUTS_CHOICE
2570 \begin_layout Description
2571 Action Displays list of layout choices.
2574 \begin_layout Description
2575 Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox
2576 allowing for choice of layout.
2579 \begin_layout Description
2580 Syntax drop-layouts-choice
2583 \begin_layout Subsection*
2584 LFUN_LAYOUT_MODULES_CLEAR
2587 \begin_layout Description
2588 Action Clears the module list.
2591 \begin_layout Description
2592 Notion Clears the list of included modules for the current buffer.
2595 \begin_layout Description
2596 Syntax layout-modules-clear
2599 \begin_layout Description
2600 Origin rgh, 25 August 2007
2603 \begin_layout Subsection*
2604 LFUN_LAYOUT_MODULE_ADD
2607 \begin_layout Description
2608 Action Adds a module.
2611 \begin_layout Description
2612 Notion Adds a module to the list of included modules for the current buffer.
2615 \begin_layout Description
2616 Syntax layout-module-add <MODULE>
2619 \begin_layout Description
2620 Params <MODULE>: the module to be added
2623 \begin_layout Description
2624 Origin rgh, 25 August 2007
2627 \begin_layout Subsection*
2631 \begin_layout Description
2632 Action Reloads layout information.
2635 \begin_layout Description
2636 Notion Reloads all layout information for the current buffer from disk,
2637 thus recognizing any changes that have been made to layout files on the
2639 This is intended to be used only by layout developers and should not be
2640 used when one is trying to do actual work.
2643 \begin_layout Description
2644 Syntax layout-reload
2647 \begin_layout Description
2648 Origin rgh, 3 September 2007
2651 \begin_layout Subsection*
2652 LFUN_TEXTCLASS_APPLY
2655 \begin_layout Description
2656 Action Sets the text class for the current buffer.
2659 \begin_layout Description
2660 Syntax textclass-apply <TEXTCLASS>
2663 \begin_layout Description
2664 Params <TEXTCLASS>: the textclass to set.
2665 Note that this must be the filename, minus the ".layout" extension.
2668 \begin_layout Subsection*
2672 \begin_layout Description
2673 Action Loads information for a textclass from disk.
2676 \begin_layout Description
2677 Syntax textclass-load <TEXTCLASS>
2680 \begin_layout Description
2681 Params <TEXTCLASS>: the textclass to load.
2682 Note that this must be the filename, minus the ".layout" extension.
2685 \begin_layout Subsection*
2689 \begin_layout Description
2690 Action Disable selecting of text-region.
2693 \begin_layout Description
2697 \begin_layout Subsection*
2701 \begin_layout Description
2702 Action Enable selecting of text-region.
2705 \begin_layout Description
2706 Notion After enabling you can simply move arrow keys to get selected region.
2709 \begin_layout Description
2713 \begin_layout Subsection*
2717 \begin_layout Description
2718 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
2721 \begin_layout Description
2725 \begin_layout Description
2726 Origin Andre, May 5 2006
2729 \begin_layout Subsection*
2733 \begin_layout Description
2734 Action Inserts math delimiters (e.g.
2735 parentheses, brackets) enclosing expression.
2738 \begin_layout Description
2739 Syntax math-delim [<LEFT>] [<RIGHT>]
2742 \begin_layout Description
2743 Params <LEFT/RIGHT>: Delimiters to be used.
2744 Each delimiter can be specified by either a LaTeX name or a valid character.
2745 ( is the default letter.
2748 \begin_layout Description
2749 Sample math-delim { rangle
2752 \begin_layout Description
2753 Origin Alejandro, 18 Jun 1996
2756 \begin_layout Subsection*
2760 \begin_layout Description
2761 Action Inserts math fixed size delimiters (e.g.
2762 parentheses, brackets) enclosing expression.
2765 \begin_layout Description
2766 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
2769 \begin_layout Description
2770 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
2771 \begin_inset Newline newline
2774 <L/RDELIM>: TeX code for delimiter.
2775 See Delimiter dialog for delimiters to be used.
2778 \begin_layout Description
2779 Sample math-bigdelim "Bigl" "
2786 \begin_layout Description
2787 Origin Enrico & Georg, 7 May 2006
2790 \begin_layout Subsection*
2794 \begin_layout Description
2795 Action Creates a new displayed equation in text mode.
2796 Toggles inlined/display formula in math mode.
2799 \begin_layout Description
2800 Syntax math-display [<ARG>]
2803 \begin_layout Description
2804 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating
2805 new equation from the text mode.
2808 \begin_layout Description
2809 Origin Alejandro, 18 Jun 1996
2812 \begin_layout Subsection*
2816 \begin_layout Description
2817 Action Inserts math objects and symbols.
2820 \begin_layout Description
2821 Notion When <ARG> is a _single_ math inset with more than one cell (such
2824 frac{x}{y}"), the content of cell(0) is replaced by the current selection
2825 (only works if the selection is in mathed).
2826 As an example, if "abc" is selected in mathed, "math-insert
2828 frac{x}{y}" replaces "abc" with "
2830 frac{abc}{y}", and "math-insert x_y^z" replaces "abc" with "abc_y^z".
2831 If nothing is selected (or the selection is not in mathed), math-insert
2835 \begin_layout Description
2836 Syntax math-insert <ARG>
2839 \begin_layout Description
2840 Params <ARG>: Symbol or LaTeX code to be inserted.
2843 \begin_layout Subsection*
2847 \begin_layout Description
2848 Action Enters subscript expression in math expression.
2851 \begin_layout Description
2852 Syntax math-subscript
2855 \begin_layout Description
2856 Origin vermeer, 12 Dec 2001
2859 \begin_layout Subsection*
2860 LFUN_MATH_SUPERSCRIPT
2863 \begin_layout Description
2864 Action Enters subscript expression in math expression.
2867 \begin_layout Description
2868 Syntax math-superscript
2871 \begin_layout Description
2872 Origin vermeer, 12 Dec 2001
2875 \begin_layout Subsection*
2879 \begin_layout Description
2880 Action Toggles the position of the limits from above/below to the right
2881 side an vice versa in integral symbol, a limit, a summation, etc.
2884 \begin_layout Description
2885 Notion Put the cursor before the symbol with the limits and then invoke
2889 \begin_layout Description
2890 Syntax math-limits [<STATE>]
2893 \begin_layout Description
2894 Params <STATE>: limits|nolimits
2897 \begin_layout Subsection*
2901 \begin_layout Description
2902 Action Inserts a math macro definition at the cursor position in the text.
2905 \begin_layout Description
2906 Syntax math-macro <NAME> [<NARGS>] [def]
2909 \begin_layout Description
2910 Params <NAME>: The name of the macro, e.g.
2912 \begin_inset Newline newline
2915 <NARGS>: The number of parameters of the macro.
2917 "def": Has no effect anymore, just for compatibility with former LyX versions.
2920 \begin_layout Description
2921 Origin ale, 10 May 1997; sts, 21 Dec 2007
2924 \begin_layout Subsection*
2928 \begin_layout Description
2929 Action Mutates the type of math inset to the newly selected one.
2932 \begin_layout Description
2933 Syntax math-mutate <TYPE>
2936 \begin_layout Description
2937 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
2938 multline|gather|flalign
2941 \begin_layout Description
2942 Origin Andre, 23 May 2001
2945 \begin_layout Subsection*
2949 \begin_layout Description
2950 Action Inserts space into math expression.
2953 \begin_layout Description
2954 Notion Use spacebar after entering this space to change type of space.
2957 \begin_layout Description
2958 Syntax math-space [<TYPE>] [<LEN>]
2961 \begin_layout Description
2962 Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
2963 \begin_inset Newline newline
2966 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
2967 \begin_inset Newline newline
2970 custom space: hspace
2971 \begin_inset Newline newline
2974 "," used by default.
2975 \begin_inset Newline newline
2978 Note that ! is equivalent to negthinspace, , = thinspace, : = medspace,
2980 \begin_inset Newline newline
2983 <LEN>: length for custom spaces (hspace)
2986 \begin_layout Description
2987 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
2990 \begin_layout Subsection*
2994 \begin_layout Description
2995 Action Inserts a matrix.
2998 \begin_layout Description
2999 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
3002 \begin_layout Description
3003 Params <ALIGN>: Alignment is a word composed of the vertical alignment (b,
3005 1 char) and the horizontal alignments (l, c or r) (i.e.
3009 \begin_layout Description
3010 Sample math-matrix 3 3 bccc
3013 \begin_layout Subsection*
3014 LFUN_MATH_AMS_MATRIX
3017 \begin_layout Description
3018 Action Inserts a matrix.
3021 \begin_layout Description
3022 Syntax math-matrix <COLS> <ROWS> [<DECORATION>]
3025 \begin_layout Description
3026 Params <DECORATION>: Decoration determines the LaTeX name of the matrix
3027 that should be created.
3030 \begin_layout Description
3031 Sample math-ams-matrix 3 3 bmatrix
3034 \begin_layout Subsection*
3038 \begin_layout Description
3039 Action In text mode enters math mode (i.e.
3040 puts math insets on the current cursor position), in math mode enters text
3041 mode inside math expression.
3044 \begin_layout Description
3045 Notion If there is some selected text, it puts the text inside created math
3049 \begin_layout Description
3050 Syntax math-mode [on|<ARG>]
3053 \begin_layout Description
3054 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT
3056 \begin_inset Newline newline
3059 "on": allow only entering of math mode from text mode.
3062 \begin_layout Description
3063 Origin Alejandro, 4 Jun 1996
3066 \begin_layout Subsection*
3070 \begin_layout Description
3071 Action Enters regexp mode (i.e., puts regexp insets on the current cursor
3073 Used by the advanced search dialog.
3076 \begin_layout Description
3077 Notion If there is any selected text, then it is moved inside the created
3081 \begin_layout Description
3082 Syntax regexp-mode [<ARG>]
3085 \begin_layout Description
3086 Params <ARG>: eventual argument (regular expression).
3089 \begin_layout Description
3090 Origin Tommaso, 4 Oct 2008
3093 \begin_layout Subsection*
3094 LFUN_MATH_NUMBER_LINE_TOGGLE
3097 \begin_layout Description
3098 Action Toggles numbering of the current formula line.
3101 \begin_layout Description
3102 Notion Must be in display formula mode.
3105 \begin_layout Description
3106 Syntax math-number-line-toggle
3109 \begin_layout Description
3110 Origin Alejandro, 18 Jun 1996
3113 \begin_layout Subsection*
3114 LFUN_MATH_NUMBER_TOGGLE
3117 \begin_layout Description
3118 Action Toggles numbering/labeling of the current formula.
3121 \begin_layout Description
3122 Notion Must be in display formula mode.
3125 \begin_layout Description
3126 Syntax math-number-toggle
3129 \begin_layout Description
3130 Origin Alejandro, 4 Jun 1996
3133 \begin_layout Subsection*
3137 \begin_layout Description
3138 Action Calls external program and passes the current expression/equation
3139 as an argument for the calculation in the format appropriate to the given
3143 \begin_layout Description
3144 Notion Selection can be used to determine the input for the external program.
3147 \begin_layout Description
3148 Syntax math-extern <LANG> [<COMMAND>]
3151 \begin_layout Description
3152 Params <LANG>: octave|maxima|maple|mathematica|script
3153 \begin_inset Newline newline
3156 where "script" stands fot the external script (normalized expression will
3160 \begin_layout Description
3161 Sample math-extern maple simplify
3164 \begin_layout Description
3165 Origin Andre, 24 Apr 2001
3168 \begin_layout Subsection*
3172 \begin_layout Description
3173 Action Changes arbitrarily the size used by math fonts inside a context.
3176 \begin_layout Description
3177 Notion Provides an interface to the LaTeX math mode font size commands.
3180 \begin_layout Description
3181 Syntax math-size <STYLE>
3184 \begin_layout Description
3196 \begin_layout Description
3197 Origin Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
3200 \begin_layout Subsection*
3201 LFUN_MATH_FONT_STYLE
3204 \begin_layout Description
3205 Action Changes the text style used in math.
3208 \begin_layout Description
3209 Syntax math-font-style <STYLE>
3212 \begin_layout Description
3213 Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf |textnormal|tex
3214 trm|textsf|texttt|textbf|textmd|textit |textsc|textsl|textup
3217 \begin_layout Description
3218 Origin vfr, 9 jan 2009
3221 \begin_layout Subsection*
3222 LFUN_MATH_MACRO_UNFOLD
3225 \begin_layout Description
3226 Action Unfold a Math Macro.
3229 \begin_layout Description
3230 Notion Unfold the Math Macro the cursor is in, i.e.
3236 \begin_layout Description
3237 Syntax math-macro-unfold
3240 \begin_layout Description
3241 Origin sts, 06 January 2008
3244 \begin_layout Subsection*
3245 LFUN_MATH_MACRO_FOLD
3248 \begin_layout Description
3249 Action Fold a Math Macro.
3252 \begin_layout Description
3253 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e.
3259 \begin_layout Description
3260 Syntax math-macro-fold
3263 \begin_layout Description
3264 Origin sts, 06 January 2008
3267 \begin_layout Subsection*
3268 LFUN_MATH_MACRO_ADD_PARAM
3271 \begin_layout Description
3272 Action Add a parameter.
3275 \begin_layout Description
3276 Notion Add a parameter to a Math Macro.
3279 \begin_layout Description
3280 Syntax math-macro-add-param <NUM>
3283 \begin_layout Description
3284 Params <NUM>: The number of the parameter behind which the new one will
3285 be added (1 for the first, i.e.
3286 use 0 for add a parameter at the left), defaults to the last one.
3289 \begin_layout Description
3290 Origin sts, 06 January 2008
3293 \begin_layout Subsection*
3294 LFUN_MATH_MACRO_REMOVE_PARAM
3297 \begin_layout Description
3298 Action Remove the last parameter.
3301 \begin_layout Description
3302 Notion Remove the last parameter of a Math Macro and remove its value in
3303 all instances of the macro in the buffer.
3306 \begin_layout Description
3307 Syntax math-macro-remove-param <NUM>
3310 \begin_layout Description
3311 Params <NUM>: The number of the parameter to be deleted (1 for the first),
3312 defaults to the last one.
3315 \begin_layout Description
3316 Origin sts, 06 January 2008
3319 \begin_layout Subsection*
3320 LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
3323 \begin_layout Description
3324 Action Append a greedy parameter.
3327 \begin_layout Description
3328 Notion Append a greedy parameter to a Math Macro which eats the following
3329 mathed cell in every instance of the macro in the buffer.
3332 \begin_layout Description
3333 Syntax math-macro-append-greedy-param
3336 \begin_layout Description
3337 Origin sts, 06 January 2008
3340 \begin_layout Subsection*
3341 LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
3344 \begin_layout Description
3345 Action Remove a greedy parameter.
3348 \begin_layout Description
3349 Notion Remove a greedy parameter of a Math Macro and spit out the values
3350 of it in every instance of the macro in the buffer.
3351 If it is an optional parameter the [valud] format is used.
3354 \begin_layout Description
3355 Syntax math-macro-remove-greedy-param
3358 \begin_layout Description
3359 Origin sts, 06 January 2008
3362 \begin_layout Subsection*
3363 LFUN_MATH_MACRO_MAKE_OPTIONAL
3366 \begin_layout Description
3367 Action Make a parameter optional.
3370 \begin_layout Description
3371 Notion Turn the first non-optional parameter of a Math Macro into an optional
3372 parameter with a default value.
3375 \begin_layout Description
3376 Syntax math-macro-make-optional
3379 \begin_layout Description
3380 Origin sts, 06 January 2008
3383 \begin_layout Subsection*
3384 LFUN_MATH_MACRO_MAKE_NONOPTIONAL
3387 \begin_layout Description
3388 Action Make a parameter non-optional.
3391 \begin_layout Description
3392 Notion Turn the last optional parameter of a Math Macro into a non-optional
3394 The default value is remembered to be reused later if the user changes
3398 \begin_layout Description
3399 Syntax math-macro-make-nonoptional
3402 \begin_layout Description
3403 Origin sts, 06 January 2008
3406 \begin_layout Subsection*
3407 LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
3410 \begin_layout Description
3411 Action Add an optional parameter.
3414 \begin_layout Description
3415 Notion Insert an optional parameter just behind the already existing optional
3419 \begin_layout Description
3420 Syntax math-macro-add-optional-param
3423 \begin_layout Description
3424 Origin sts, 06 January 2008
3427 \begin_layout Subsection*
3428 LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
3431 \begin_layout Description
3432 Action Remove the last optional parameter.
3435 \begin_layout Description
3436 Notion Remove the last optional parameter of a Math Macro and remove it
3437 in all the instances of the macro in the buffer.
3440 \begin_layout Description
3441 Syntax math-macro-remove-optional-param
3444 \begin_layout Description
3445 Origin sts, 06 January 2008
3448 \begin_layout Subsection*
3449 LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
3452 \begin_layout Description
3453 Action Add a greedy optional parameter.
3456 \begin_layout Description
3457 Notion Add a greedy optional parameter which eats the value from the following
3458 cells in mathed which are in the [value] format.
3461 \begin_layout Description
3462 Syntax math-macro-add-greedy-optional-param
3465 \begin_layout Description
3466 Origin sts, 06 January 2008
3469 \begin_layout Subsection*
3470 LFUN_IN_MATHMACROTEMPLATE
3473 \begin_layout Description
3474 Action Only active in Math Macro definition.
3477 \begin_layout Description
3478 Notion Dummy function which is only active in a Math Macro definition.
3479 It's used to toggle the Math Macro toolbar if the cursor moves into a Math
3483 \begin_layout Description
3484 Syntax in-mathmacrotemplate
3487 \begin_layout Description
3488 Origin sts, 06 January 2008
3491 \begin_layout Subsection*
3492 LFUN_PARAGRAPH_MOVE_DOWN
3495 \begin_layout Description
3496 Action Moves the current paragraph downwards in the document.
3499 \begin_layout Description
3500 Syntax paragraph-move-down
3503 \begin_layout Description
3504 Origin Edwin, 8 Apr 2006
3507 \begin_layout Subsection*
3508 LFUN_PARAGRAPH_MOVE_UP
3511 \begin_layout Description
3512 Action Moves the current paragraph upwards in the document.
3515 \begin_layout Description
3516 Syntax paragraph-move-up
3519 \begin_layout Description
3520 Origin Edwin, 8 Apr 2006
3523 \begin_layout Subsection*
3527 \begin_layout Description
3528 Action Move the cursor to the next paragraph (or begining of the current
3529 one) in upward direction.
3532 \begin_layout Description
3536 \begin_layout Description
3537 Origin Asger, 1 Oct 1996
3540 \begin_layout Subsection*
3541 LFUN_PARAGRAPH_UP_SELECT
3544 \begin_layout Description
3545 Action Move the cursor and select the text to the next paragraph (or begining
3546 of the current one) in upward direction.
3549 \begin_layout Description
3550 Syntax paragraph-up-select
3553 \begin_layout Description
3554 Origin Asger, 1 Oct 1996
3557 \begin_layout Subsection*
3561 \begin_layout Description
3562 Action Move the cursor to the next paragraph (or begining of the current
3563 one) in downward direction.
3566 \begin_layout Description
3567 Syntax paragraph-down
3570 \begin_layout Description
3571 Origin Asger, 1 Oct 1996
3574 \begin_layout Subsection*
3575 LFUN_PARAGRAPH_DOWN_SELECT
3578 \begin_layout Description
3579 Action Move the cursor and select the text to the next paragraph (or begining
3580 of the current one) in downward direction.
3583 \begin_layout Description
3584 Syntax paragraph-down-select
3587 \begin_layout Description
3588 Origin Asger, 1 Oct 1996
3591 \begin_layout Subsection*
3595 \begin_layout Description
3596 Action Jump to a paragraph given by its id number and optionally the desired
3597 position within the paragraph.
3600 \begin_layout Description
3601 Notion Note that id number of paragraph is not the sequential number of
3602 paragraph seen on the screen.
3603 Moreover the id is unique for all opened buffers (documents).
3606 \begin_layout Description
3607 Syntax paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
3610 \begin_layout Description
3611 Params <PAR_ID_NUMBER>: paragraph id
3612 \begin_inset Newline newline
3615 <POSITION_IN_PAR>: desired position within the paragraph
3618 \begin_layout Description
3619 Origin Dekel, 26 Aug 2000
3622 \begin_layout Subsection*
3623 LFUN_BREAK_PARAGRAPH
3626 \begin_layout Description
3627 Action Breaks the current paragraph at the current location.
3630 \begin_layout Description
3631 Notion Removes the selection.
3634 \begin_layout Description
3635 Syntax break-paragraph [<LAYOUT>]
3638 \begin_layout Description
3639 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to
3640 default layout) when the cursor is at the end of the line.
3643 \begin_layout Subsection*
3644 LFUN_PARAGRAPH_PARAMS
3647 \begin_layout Description
3648 Action Change paragraph settings.
3651 \begin_layout Description
3652 Notion Modifies the current paragraph, or currently selected paragraphs.
3653 This function only modifies, and does not override, existing settings.
3654 Note that the "leftindent" indent setting is deprecated.
3657 \begin_layout Description
3658 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
3661 \begin_layout Description
3671 \begin_inset Newline newline
3676 paragraph_spacing default|single|onehalf|double|other SIZE
3677 \begin_inset Newline newline
3682 align block|left|right|center|default
3683 \begin_inset Newline newline
3688 labelwidthstring WIDTH|
3693 \begin_layout Description
3694 Origin rgh, Aug 15 2007
3697 \begin_layout Subsection*
3698 LFUN_PARAGRAPH_PARAMS_APPLY
3701 \begin_layout Description
3702 Action Change paragraph settings.
3705 \begin_layout Description
3706 Notion Overwrite all nonspecified settings to the default ones.
3707 Use paragraph-params lfun if you don't want to overwrite others settings.
3710 \begin_layout Description
3711 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
3714 \begin_layout Description
3715 Params For parameters see LFUN_PARAGRAPH_PARAMS
3718 \begin_layout Description
3719 Origin leeming, 30 Mar 2004
3722 \begin_layout Subsection*
3723 LFUN_PARAGRAPH_UPDATE
3726 \begin_layout Description
3727 Action Updates the values inside the paragraph dialog from the paragraph.
3730 \begin_layout Description
3731 Notion This is internal LFUN, not to be used by users.
3732 Called internally by LFUN_DIALOG_UPDATE.
3735 \begin_layout Description
3736 Origin leeming, 13 Mar 2003
3739 \begin_layout Subsection*
3743 \begin_layout Description
3744 Action Move the current group in the upward direction in the structure of
3748 \begin_layout Description
3749 Notion The "group" can be Part/Chapter/Section/etc.
3750 It moves the whole substructure of the group.
3753 \begin_layout Description
3757 \begin_layout Description
3758 Origin Vermeer, 23 Mar 2006
3761 \begin_layout Subsection*
3765 \begin_layout Description
3766 Action Move the current group in the downward direction in the structure
3770 \begin_layout Description
3771 Notion The "group" can be Part/Chapter/Section/etc.
3772 It moves the whole substructure of the group.
3775 \begin_layout Description
3779 \begin_layout Description
3780 Origin Vermeer, 23 Mar 2006
3783 \begin_layout Subsection*
3787 \begin_layout Description
3788 Action Moves the current group in the downward direction in the hierarchy
3789 of the document structure.
3792 \begin_layout Description
3793 Notion Part -> Chapter -> Section -> etc.
3796 \begin_layout Description
3800 \begin_layout Description
3801 Origin Vermeer, 23 Mar 2006
3804 \begin_layout Subsection*
3808 \begin_layout Description
3809 Action Moves the current group in the upward direction in the hierarchy
3810 of the document structure.
3813 \begin_layout Description
3814 Notion Part <- Chapter <- Section <- etc.
3817 \begin_layout Description
3821 \begin_layout Description
3822 Origin Vermeer, 23 Mar 2006
3825 \begin_layout Subsection*
3826 LFUN_OUTLINE_DRAGMOVE
3829 \begin_layout Description
3830 Action Moves the document section associated with the specified heading
3831 to a specified location.
3832 Both the heading and the target paragraph are specified by the paragraph
3836 \begin_layout Description
3837 Notion The heading is a paragraph with style Part/Chapter/Section/ etc.
3838 Id number of the paragraph is not the sequential number seen on the screen,
3839 but an internal number that is unique for all opened buffers (documents).
3842 \begin_layout Description
3843 Syntax outline-dragmove <PAR_ID_SECTION> <PAR_ID_DROP_POSITION>
3846 \begin_layout Description
3847 Params <PAR_ID_SECTION>: paragraph id of the section heading which is to
3849 \begin_inset Newline newline
3852 <PAR_ID_DROP_POSITION>: the paragraph id where the section will be moved
3856 \begin_layout Description
3857 Origin Rob Oakes, 22 June 2009
3860 \begin_layout Subsection*
3864 \begin_layout Description
3865 Action Edit the inset at cursor with an external application, if one is
3869 \begin_layout Description
3870 Syntax inset-edit [<INSET_PARAMS>]
3873 \begin_layout Description
3874 Params <INSET_PARAMS>: Parameters for the inset.
3875 \begin_inset Newline newline
3878 Currently only the filename will be considered.
3881 \begin_layout Description
3882 Origin JSpitzm, 27 Apr 2006
3885 \begin_layout Subsection*
3889 \begin_layout Description
3890 Action Inserts table into the document.
3893 \begin_layout Description
3894 Syntax tabular-insert [<ROWS> <COLUMNS>]
3897 \begin_layout Description
3898 Params In case no arguments are given show insert dialog.
3901 \begin_layout Description
3902 Origin Jug, 12 Apr 2000
3905 \begin_layout Subsection*
3906 LFUN_TABULAR_FEATURE
3909 \begin_layout Description
3910 Action Sets various features to the table/cell on the current cursor position.
3913 \begin_layout Description
3914 Notion Various math-environment features are handled here as well, e.g.
3915 add-vline-left/right for the Grid/Array environment
3918 \begin_layout Description
3919 Syntax tabular-feature <FEATURE> [<ARG>]
3922 \begin_layout Description
3923 Params <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|cop
3924 y-column| toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
3925 align-left|align-right|align-center|align-block|valign-top|valign-bottom|
3926 valign-middle|longtabular-align-left|longtabular-align-center| longtabular-alig
3927 n-right|m-align-left|m-align-right|m-align-center| m-valign-top|m-valign-bottom|
3928 m-valign-middle|multicolumn|set-all-lines| unset-all-lines|set-longtabular|unset
3929 -longtabular|set-pwidth|set-mpwidth| set-rotate-tabular|unset-rotate-tabular|tog
3930 gle-rotate-tabular| set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-use
3931 box|set-lthead| unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-
3932 ltfoot| set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
3933 set-special-column|set-special-multi|set-booktabs|unset-booktabs| set-top-space
3934 |set-bottom-space|set-interline-space|set-border-lines| tabular-valign-top|tabul
3935 ar-valign-middle|tabular-valign-bottom
3936 \begin_inset Newline newline
3939 <ARG>: additional argument for some commands, use debug mode to explore
3943 \begin_layout Description
3944 Origin Jug, 28 Jul 2000
3947 \begin_layout Subsection*
3951 \begin_layout Description
3952 Action Moves the cursor to the previous cell inside the table.
3955 \begin_layout Description
3956 Syntax cell-backward
3959 \begin_layout Description
3960 Origin Jug, 22 May 2000
3963 \begin_layout Subsection*
3967 \begin_layout Description
3968 Action Moves the cursor to the next cell inside the table.
3971 \begin_layout Description
3975 \begin_layout Subsection*
3979 \begin_layout Description
3980 Action Splits cell and shifts right part to the next cell (inside the math
3984 \begin_layout Description
3988 \begin_layout Description
3989 Origin Ale, 15 May 1997
3992 \begin_layout Subsection*
3996 \begin_layout Description
3997 Action Register the document as an file inside version control system (RCS,
4001 \begin_layout Description
4002 Notion File is registered inside cvs, svn or rcs repository acording to
4003 the existence of cvs/svn/rcs entries in the document's directory.
4004 \begin_inset Newline newline
4007 See LyX Additional Features Manual (Version Control Chapter) for additional
4011 \begin_layout Description
4015 \begin_layout Description
4016 Origin Lgb, 1 Jul 1997
4019 \begin_layout Subsection*
4023 \begin_layout Description
4024 Action Checks-in/commits the changes of the registered file to the repository.
4027 \begin_layout Description
4028 Notion In RCS case this also unlocks the file.
4031 \begin_layout Description
4035 \begin_layout Description
4036 Origin Lgb, 1 Jul 1997
4039 \begin_layout Subsection*
4043 \begin_layout Description
4044 Action Checks-out the document for edit (and locks it for RCS).
4047 \begin_layout Description
4048 Notion This is implemented only for RCS and SVN, not CVS.
4051 \begin_layout Description
4055 \begin_layout Description
4056 Origin Lgb, 1 Jul 1997
4059 \begin_layout Subsection*
4063 \begin_layout Description
4064 Action Reverts the document to the last check-in/commit in VCS.
4067 \begin_layout Description
4071 \begin_layout Description
4072 Origin Lgb, 1 Jul 1997
4075 \begin_layout Subsection*
4079 \begin_layout Description
4080 Action Undo last check-in.
4083 \begin_layout Description
4084 Notion This is currently implemented only for RCS.
4087 \begin_layout Description
4091 \begin_layout Description
4092 Origin Lgb, 1 Jul 1997
4095 \begin_layout Subsection*
4099 \begin_layout Description
4100 Action Executes external command.
4101 This command is intended to support additional VCS commands.
4104 \begin_layout Description
4105 Syntax vc-command <FLAG> <PATH> <COMMAND>
4108 \begin_layout Description
4109 Params <FLAG>: Flags for the command can be combined together.
4110 \begin_inset Newline newline
4113 U - dUmmy - no flags
4114 \begin_inset Newline newline
4117 D - Doc - need document loaded to proceed
4118 \begin_inset Newline newline
4121 I - dIrty - mark document dirty
4122 \begin_inset Newline newline
4125 R - Reload - ensure that the document is saved and reload it after command
4127 \begin_inset Newline newline
4130 M - Message - ask for input string (commit message)
4131 \begin_inset Newline newline
4134 <PATH>: path where to start.
4135 $$p will be replaced by the current document path.
4136 \begin_inset Newline newline
4139 <COMMAND>: command to execute.
4140 $$i/$$p/$$m will be replaced by the current document/path/message.
4143 \begin_layout Description
4144 Sample vc-command DR $$p "svn up"
4147 \begin_layout Description
4148 Origin sanda, 13 Jan 2009
4151 \begin_layout Subsection*
4152 LFUN_VC_LOCKING_TOGGLE
4155 \begin_layout Description
4156 Action Toggles the locking property of the edited file.
4159 \begin_layout Description
4160 Notion This is currently implemented only for SVN.
4163 \begin_layout Description
4164 Syntax vc-locking-toggle
4167 \begin_layout Description
4168 Origin sanda, 25 Jun 2009
4171 \begin_layout Subsection*
4172 LFUN_VC_REPO_SYNCHRO
4175 \begin_layout Description
4176 Action Synchronize the local archive directory in which resides the current
4177 document with the repository.
4180 \begin_layout Description
4181 Notion This is currently implemented only for SVN as revert + update operation.
4184 \begin_layout Description
4185 Syntax vc-repo-synchro
4188 \begin_layout Description
4189 Origin sanda, 16 Oct 2009
4192 \begin_layout Subsection*
4196 \begin_layout Description
4197 Action Toggles change tracking to on/off.
4200 \begin_layout Description
4201 Syntax changes-track
4204 \begin_layout Description
4205 Origin levon, 1 Oct 2002
4208 \begin_layout Subsection*
4212 \begin_layout Description
4213 Action Toggles showing of change tracking in typesetted output.
4216 \begin_layout Description
4217 Syntax changes-output
4220 \begin_layout Description
4221 Origin jspitzm, 21 Jan 2005
4224 \begin_layout Subsection*
4228 \begin_layout Description
4229 Action Moves the cursor to the position of the next change of the change
4233 \begin_layout Description
4237 \begin_layout Description
4238 Origin schmitt, 4 Oct 2006
4241 \begin_layout Subsection*
4242 LFUN_CHANGE_PREVIOUS
4245 \begin_layout Description
4246 Action Moves the cursor to the position of the previous change of the change
4250 \begin_layout Description
4251 Syntax change-previous
4254 \begin_layout Description
4255 Origin vfr, 4 Apr 2009
4258 \begin_layout Subsection*
4262 \begin_layout Description
4263 Action Open change tracking dialog for merging and moves the cursor to the
4264 position of the next change.
4267 \begin_layout Description
4268 Syntax changes-merge
4271 \begin_layout Description
4272 Origin Levon, 16 Oct 2002
4275 \begin_layout Subsection*
4279 \begin_layout Description
4280 Action Accepts tracked change inside the selection.
4283 \begin_layout Description
4284 Syntax change-accept
4287 \begin_layout Description
4288 Origin Levon, 16 Oct 2002
4291 \begin_layout Subsection*
4295 \begin_layout Description
4296 Action Rejects tracked change inside the selection.
4299 \begin_layout Description
4300 Syntax change-accept
4303 \begin_layout Description
4304 Origin Levon, 16 Oct 2002
4307 \begin_layout Subsection*
4308 LFUN_ALL_CHANGES_ACCEPT
4311 \begin_layout Description
4312 Action Accepts all tracked changes in the document.
4315 \begin_layout Description
4316 Syntax all-changes-accept
4319 \begin_layout Description
4320 Origin Levon, 16 Oct 2002
4323 \begin_layout Subsection*
4324 LFUN_ALL_CHANGES_REJECT
4327 \begin_layout Description
4328 Action Rejects all tracked changes in the document.
4331 \begin_layout Description
4332 Notion Reject does not work recursively; the user may have to repeat the
4336 \begin_layout Description
4337 Syntax all-changes-reject
4340 \begin_layout Description
4341 Origin Levon, 16 Oct 2002
4344 \begin_layout Subsection*
4348 \begin_layout Description
4349 Action Apply data for an inset.
4352 \begin_layout Description
4353 Notion LFUN_INSET_APPLY is sent from the dialogs when the data should be
4355 This is either changed to LFUN_INSET_MODIFY or LFUN_INSET_INSERT depending
4356 on the context where it is called.
4359 \begin_layout Description
4360 Syntax inset-apply <ARGS>
4363 \begin_layout Description
4364 Params See LFUN_INSET_INSERT .
4367 \begin_layout Subsection*
4371 \begin_layout Description
4372 Action Dissolve the current inset into text.
4375 \begin_layout Description
4376 Syntax inset-dissolve [<INSET>]
4379 \begin_layout Description
4380 Params <INSET>: this can be used to make sure the right kind of inset is
4382 For example "dissolve" entry in the charstyles sub-menu should only dissolve
4383 the charstyle inset, even if the cursor is inside several nested insets
4385 \begin_inset Newline newline
4388 For values see lyx::InsetLayout::lyxtype_ .
4391 \begin_layout Description
4392 Origin JSpitz, 7 Aug 2006
4395 \begin_layout Subsection*
4399 \begin_layout Description
4400 Action Insert new inset (type given by the parameters).
4403 \begin_layout Description
4404 Syntax inset-insert <INSET> <ARGS>
4407 \begin_layout Description
4408 Params <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics| hyperlink|i
4409 nclude|index|label|nomencl|vspace|ref|toc>
4410 \begin_inset Newline newline
4413 <ARGS>: depends on the given inset.
4414 Use "lyx -dbg action" to explore.
4417 \begin_layout Description
4418 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
4421 \begin_inset Newline newline
4424 where <label name> is the name of the referenced label and <Format> is one
4426 \begin_inset Newline newline
4430 \begin_inset Newline newline
4433 eqref -- (<reference>)
4434 \begin_inset Newline newline
4438 \begin_inset Newline newline
4441 vpageref -- on <page>
4442 \begin_inset Newline newline
4445 vref -- <reference> on <page>
4446 \begin_inset Newline newline
4449 prettyref -- Formatted reference
4452 \begin_layout Subsection*
4456 \begin_layout Description
4457 Action Modify existing inset.
4460 \begin_layout Description
4461 Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats,
4462 graphics, include, label, listings, note, phantom, ref, space, tabular,
4463 vspace, wrap insets.
4466 \begin_layout Description
4467 Syntax inset-modify <INSET> <ARGS>
4470 \begin_layout Description
4471 Params See LFUN_INSET_INSERT for further details.
4474 \begin_layout Subsection*
4475 LFUN_NEXT_INSET_MODIFY
4478 \begin_layout Description
4479 Action Modify the inset at cursor position, if there is one.
4482 \begin_layout Description
4483 Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats,
4484 graphics, include, label, listings, note, phantom, ref, space, tabular,
4485 vspace, wrap insets.
4488 \begin_layout Description
4489 Syntax next-inset-modify <INSET> <ARGS>next-inset-modify changetype <TYPE>
4492 \begin_layout Description
4493 Params See LFUN_INSET_INSERT for further details.
4496 \begin_layout Description
4497 Origin JSpitzm, 23 Mar 2008
4500 \begin_layout Subsection*
4501 LFUN_INSET_DIALOG_UPDATE
4504 \begin_layout Description
4505 Action Updates the values inside the dialog from the inset.
4508 \begin_layout Description
4509 Notion This is internal LFUN, not to be used by users.
4510 Called internally by LFUN_DIALOG_UPDATE
4513 \begin_layout Description
4514 Params <DIALOG-NAME>
4517 \begin_layout Description
4518 Origin leeming, 25 Feb 2003
4521 \begin_layout Subsection*
4525 \begin_layout Description
4526 Action Open the inset's properties dialog.
4529 \begin_layout Description
4530 Notion Used for bibitem, bibtex, box, branch, citation, ert, external, float,
4531 graphics, href, include, index, index_print, label, listings, note, phantom,
4532 ref, space, tabular, vspace, wrap insets.
4535 \begin_layout Description
4536 Syntax inset-settings <INSET>
4539 \begin_layout Description
4540 Params <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
4541 graphics|href|include|index|index_print|label|listings| note|phantom|ref|space|
4542 tabular|vspace|wrap>.
4545 \begin_layout Subsection*
4549 \begin_layout Description
4550 Action Toggles the collapsable inset at cursor position, or the inset we
4554 \begin_layout Description
4555 Syntax inset-toggle [<ARG>]
4558 \begin_layout Description
4559 Params <ARG>: <open|close|toggle|assign>.
4560 \begin_inset Newline newline
4563 open/close/toggle are for collapsable insets.
4564 toggle is used when no argument is given.
4565 \begin_inset Newline newline
4568 assign synchronize the branch-inset with activation status of the branch.
4569 Used for global toggling when changed activation.
4572 \begin_layout Description
4573 Origin lasgouttes, 19 Jul 2001
4576 \begin_layout Subsection*
4577 LFUN_ALL_INSETS_TOGGLE
4580 \begin_layout Description
4581 Action Toggles (open/closes) all collapsable insets (of a given type) in
4585 \begin_layout Description
4586 Notion Used for box, branch, ert, float, listings, note, tabular, wrap insets.
4589 \begin_layout Description
4590 Syntax all-insets-toggle [<STATE>] [<INSET>]
4593 \begin_layout Description
4594 Params <STATE>: <toggle|open|close|assign> default: toggle
4595 \begin_inset Newline newline
4598 <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all
4602 \begin_layout Description
4603 Origin leeming, 30 Mar 2004
4606 \begin_layout Subsection*
4607 LFUN_SET_GRAPHICS_GROUP
4610 \begin_layout Description
4611 Action Set the group for the graphics inset on the cursor position.
4614 \begin_layout Description
4615 Syntax set-graphics-group [<GROUP>]
4618 \begin_layout Description
4619 Params <GROUP>: Id for an existing group.
4620 In case the Id is an empty string, the graphics inset is removed from the
4624 \begin_layout Description
4625 Origin sanda, 6 May 2008
4628 \begin_layout Subsection*
4629 LFUN_FINISHED_FORWARD
4632 \begin_layout Description
4633 Action Moves the cursor out of the current slice, going forward.
4636 \begin_layout Description
4637 Notion Cursor movement within an inset may be different than cursor movement
4638 in the surrounding text.
4639 This action should be called automatically by the cursor movement within
4640 the inset, when movement within the inset has ceased (reached the end of
4641 the last paragraph, for example), in order to move correctly back into
4642 the surrounding text.
4645 \begin_layout Subsection*
4646 LFUN_FINISHED_BACKWARD
4649 \begin_layout Description
4650 Action Moves the cursor out of the current slice, going backwards.
4653 \begin_layout Description
4654 Notion See also LFUN_FINISHED_FORWARD.
4657 \begin_layout Subsection*
4661 \begin_layout Description
4662 Action Moves the cursor out of the current slice, going right.
4665 \begin_layout Description
4666 Notion See also LFUN_FINISHED_FORWARD
4669 \begin_layout Subsection*
4673 \begin_layout Description
4674 Action Moves the cursor out of the current slice, going left.
4677 \begin_layout Description
4678 Notion See also LFUN_FINISHED_FORWARD.
4681 \begin_layout Subsection*
4685 \begin_layout Description
4686 Action Set language from the current cursor position.
4689 \begin_layout Description
4690 Syntax language <LANG>
4693 \begin_layout Description
4694 Params <LANG>: Requested language.
4695 Look in lib/languages for the list.
4698 \begin_layout Description
4699 Origin Dekel, 2 Mar 2000
4702 \begin_layout Subsection*
4706 \begin_layout Description
4707 Action Goto a label.
4710 \begin_layout Description
4711 Syntax label-goto [<LABEL>]
4714 \begin_layout Description
4715 Params <LABEL>: Requested label.
4716 If no label is given and reference is on cursor position, Bookmark 0 is
4717 saved and cursor moves to the position of referenced label.
4720 \begin_layout Description
4721 Origin Ale, 6 Aug 1997
4724 \begin_layout Subsection*
4728 \begin_layout Description
4729 Action Inserts label to text or displayed formula.
4732 \begin_layout Description
4733 Syntax label-insert [<LABEL>]
4736 \begin_layout Description
4737 Params <LABEL>: Requested label.
4738 If no label is given dialog requesting name will be opened.
4741 \begin_layout Subsection*
4745 \begin_layout Description
4746 Action Go to the next label or cross-reference.
4749 \begin_layout Description
4750 Syntax reference-next
4753 \begin_layout Description
4754 Origin Dekel, 14 Jan 2001
4757 \begin_layout Subsection*
4761 \begin_layout Description
4762 Action Moves the cursor to the numbered bookmark, opening the file if necessary.
4763 Note that bookmarsk are saved per-session, not per file.
4766 \begin_layout Description
4767 Notion Bookmark 0 has a special purpose.
4768 It is automatically set
4769 \begin_inset Newline newline
4773 to the paragraph you are currently editing
4774 \begin_inset Newline newline
4778 to the paragraph from where you are jumping to the last-edited position
4780 \begin_inset Newline newline
4784 when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
4787 \begin_layout Description
4788 Syntax bookmark-goto <NUMBER>
4791 \begin_layout Description
4792 Params <NUMBER>: the number of the bookmark to restore.
4795 \begin_layout Description
4796 Origin Dekel, 27 January 2001
4799 \begin_layout Subsection*
4803 \begin_layout Description
4804 Action Save a bookmark.
4807 \begin_layout Description
4808 Notion Saves a numbered bookmark to the sessions file.
4809 The number must be between 1 and 9, inclusive.
4810 Note that bookmarks are saved per-session, not per file.
4813 \begin_layout Description
4814 Syntax bookmark-save <NUMBER>
4817 \begin_layout Description
4818 Params <NUMBER>: the number of the bookmark to save.
4821 \begin_layout Description
4822 Origin Dekel, 27 January 2001
4825 \begin_layout Subsection*
4829 \begin_layout Description
4830 Action Clears the list of saved bookmarks.
4833 \begin_layout Description
4834 Syntax bookmark-clear
4837 \begin_layout Description
4838 Origin bpeng, 31 October 2006
4841 \begin_layout Subsection*
4845 \begin_layout Description
4846 Action Open the given help file according to the language setting.
4849 \begin_layout Description
4850 Syntax help-open <FILE>[.lyx]
4853 \begin_layout Description
4854 Params <FILE>: any document from (/usr/share/)doc directory.
4857 \begin_layout Description
4858 Origin Jug, 27 Jun 1999
4861 \begin_layout Subsection*
4865 \begin_layout Description
4866 Action Terminates the current LyX instance.
4869 \begin_layout Description
4870 Notion Terminates the current LyX instance, asking whether to save modified
4874 \begin_layout Description
4878 \begin_layout Subsection*
4882 \begin_layout Description
4883 Action Toggles visibility of a given toolbar between on/off/auto.
4886 \begin_layout Description
4887 Notion Skiping "auto" when allowauto is false.
4890 \begin_layout Description
4891 Syntax toolbar-toggle <NAME> [allowauto]
4894 \begin_layout Description
4895 Params <NAME>: standard|extra|table|math|mathmacrotemplate| minibuffer|review|vi
4896 ew/update|math_panels|vcs
4899 \begin_layout Description
4900 Origin Edwin, 21 May 2007
4903 \begin_layout Subsection*
4907 \begin_layout Description
4908 Action Opens the menu given by its name.
4911 \begin_layout Description
4912 Syntax menu-open <NAME>
4915 \begin_layout Description
4916 Params <NAME>: menu name.
4917 See various .inc files in lib/ui for candidates.
4920 \begin_layout Subsection*
4924 \begin_layout Description
4925 Action Various UI visibility-toggling actions.
4928 \begin_layout Description
4929 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
4932 \begin_layout Description
4933 Params statusbar : Toggle visibility of the statusbar.
4934 \begin_inset Newline newline
4937 menubar : Toggle visibility of the menubar.
4938 \begin_inset Newline newline
4941 scrollbar : Toggle visibility of the scrollbar.
4942 \begin_inset Newline newline
4945 frame : Toggle visibility of the frames around editing window.
4946 \begin_inset Newline newline
4949 fullscreen : Toggle fullscreen mode.
4950 This also covers calling the previous functions.
4951 However LFUN_TOOLBAR_TOGGLE for the custom tweaks of the toolbars should
4955 \begin_layout Description
4956 Origin sanda, 9 Feb 2007
4959 \begin_layout Subsection*
4963 \begin_layout Description
4964 Action Creates new empty LyX window.
4967 \begin_layout Description
4968 Notion Already opened documents from the previous window can be found under
4972 \begin_layout Description
4973 Syntax window-new [<GEOMETRY>]
4976 \begin_layout Description
4977 Params <GEOMETRY>: pass the geometry of the window.
4978 This parameter is currently accepted only on Windows platform.
4981 \begin_layout Description
4982 Origin Abdel, 21 Oct 2006
4985 \begin_layout Subsection*
4989 \begin_layout Description
4990 Action Closes the current LyX window.
4993 \begin_layout Description
4997 \begin_layout Description
4998 Origin Abdel, 23 Oct 2006
5001 \begin_layout Subsection*
5005 \begin_layout Description
5006 Action Creates another split view of current buffer.
5009 \begin_layout Description
5010 Notion All split views act in the same way indpendently.
5013 \begin_layout Description
5014 Syntax split-view <vertical|horizontal>
5017 \begin_layout Description
5018 Params horizontal : The work areas are laid out side by side.
5019 \begin_inset Newline newline
5022 vertical : The work areas laid out vertically.
5025 \begin_layout Description
5026 Origin Abdel, 20 Feb 2008
5029 \begin_layout Subsection*
5030 LFUN_CLOSE_TAB_GROUP
5033 \begin_layout Description
5034 Action Close the current tab group.
5037 \begin_layout Description
5038 Notion This only closes the work areas, not the buffer themselves.
5039 The still opened buffers can be visualized in another tab group.
5042 \begin_layout Description
5043 Syntax close-tab-group
5046 \begin_layout Description
5047 Origin Abdel, 21 Feb 2008
5050 \begin_layout Subsection*
5054 \begin_layout Description
5055 Action Shows hidden dialog or create new one for a given function/inset
5059 \begin_layout Description
5060 Syntax dialog-show <NAME> [<DATA>]
5063 \begin_layout Description
5064 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
5065 \begin_inset Newline newline
5068 document|errorlist|ert|external|file|findreplace|findreplaceadv|float|graphics|
5069 \begin_inset Newline newline
5072 href|include|index|index_print|info|label|listings|log|mathdelimiter|
5073 \begin_inset Newline newline
5076 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|
5077 \begin_inset Newline newline
5080 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|
5081 \begin_inset Newline newline
5084 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL>
5085 \begin_inset Newline newline
5088 <SPECIAL>: latexlog|vclog
5089 \begin_inset Newline newline
5092 <DATA>: data, usually settings for the given dialog.
5093 Use debug mode for the details.
5096 \begin_layout Description
5097 Origin leeming, 17 Jun 2003
5100 \begin_layout Subsection*
5101 LFUN_DIALOG_SHOW_NEW_INSET
5104 \begin_layout Description
5105 Action Shows hidden dialog or create new one for a given inset settings
5109 \begin_layout Description
5110 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given
5114 \begin_layout Description
5115 Syntax dialog-show-new-inset <NAME> [<DATA>]
5118 \begin_layout Description
5119 Params See LFUN_DIALOG_SHOW .
5122 \begin_layout Description
5123 Origin leeming, 25 Feb 2003
5126 \begin_layout Subsection*
5130 \begin_layout Description
5131 Action Updates the dialog values from the inset/paragraph/document.
5134 \begin_layout Description
5135 Syntax dialog-update <NAME>
5138 \begin_layout Description
5139 Params <NAME>: paragraph|prefs|<INSET>
5140 \begin_inset Newline newline
5146 \begin_layout Description
5147 Origin leeming, 25 Feb 2003
5150 \begin_layout Subsection*
5154 \begin_layout Description
5155 Action Hides showed dialog.
5156 Counterpart to LFUN_DIALOG_SHOW .
5159 \begin_layout Description
5160 Syntax dialog-hide <NAME>
5163 \begin_layout Description
5164 Params See LFUN_DIALOG_SHOW .
5167 \begin_layout Description
5168 Origin leeming, 25 Feb 2003
5171 \begin_layout Subsection*
5175 \begin_layout Description
5176 Action Toggles dialog between showed/hidden state.
5179 \begin_layout Description
5180 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
5183 \begin_layout Description
5184 Syntax dialog-toggle <NAME> [<DATA>]
5187 \begin_layout Description
5188 Params See LFUN_DIALOG_SHOW .
5191 \begin_layout Description
5192 Origin JSpitzm, 30 Apr 2007
5195 \begin_layout Subsection*
5196 LFUN_DIALOG_DISCONNECT_INSET
5199 \begin_layout Description
5200 Action Closes opened connection to opened inset.
5203 \begin_layout Description
5204 Notion Connection is used for apply functions.
5207 \begin_layout Description
5208 Syntax dialog-disconnect-inset <INSET-NAME>
5211 \begin_layout Description
5212 Origin leeming, 25 Feb 2003
5215 \begin_layout Subsection*
5219 \begin_layout Description
5220 Action This function is called when mouse button is pressed (inside workarea).
5221 Action depends on the context.
5224 \begin_layout Description
5225 Notion This is internal LFUN, not to be used by users.
5228 \begin_layout Description
5229 Origin Andre, 9 Aug 2002
5232 \begin_layout Subsection*
5236 \begin_layout Description
5237 Action This function is called when double click on mouse button is pressed
5239 Action depends on the context.
5242 \begin_layout Description
5243 Notion This is internal LFUN, not to be used by users.
5246 \begin_layout Description
5247 Origin Andre, 9 Aug 2002
5250 \begin_layout Subsection*
5254 \begin_layout Description
5255 Action This function is called when triple click on mouse button is pressed
5257 Action depends on the context.
5260 \begin_layout Description
5261 Notion This is internal LFUN, not to be used by users.
5264 \begin_layout Description
5265 Origin Andre, 9 Aug 2002
5268 \begin_layout Subsection*
5272 \begin_layout Description
5273 Action This function is called when mouse cursor is moving over the text.
5274 Action depends on the context.
5277 \begin_layout Description
5278 Notion This is internal LFUN, not to be used by users.
5281 \begin_layout Description
5282 Origin Andre, 9 Aug 2002
5285 \begin_layout Subsection*
5289 \begin_layout Description
5290 Action This function is called when mouse button is released (inside workarea).
5291 Action depends on the context.
5294 \begin_layout Description
5295 Notion This is internal LFUN, not to be used by users.
5298 \begin_layout Description
5299 Origin Andre, 9 Aug 2002
5302 \begin_layout Subsection*
5306 \begin_layout Description
5307 Action Turn off the loaded keyboard map.
5310 \begin_layout Description
5314 \begin_layout Subsection*
5318 \begin_layout Description
5319 Action Turn on the primary keyboard map.
5322 \begin_layout Description
5323 Notion Maps were widely used in past, when X-windows didn't have nowadays
5325 They can be still used to maintain uniform keyboard layout across the various
5327 \begin_inset Newline newline
5330 The language is to be set in the Preferences dialog.
5333 \begin_layout Description
5334 Syntax keymap-primary
5337 \begin_layout Subsection*
5338 LFUN_KEYMAP_SECONDARY
5341 \begin_layout Description
5342 Action Turn on the secondary keyboard map.
5345 \begin_layout Description
5346 Syntax keymap-secondary
5349 \begin_layout Subsection*
5353 \begin_layout Description
5354 Action Toggles keyboard maps (first/second/off).
5357 \begin_layout Description
5358 Syntax keymap-toggle
5361 \begin_layout Description
5362 Origin leeming, 30 Mar 2004
5365 \begin_layout Subsection*
5366 LFUN_SERVER_GET_LAYOUT
5369 \begin_layout Description
5370 Action Returns the current layout (that is environment) name on the cursor
5374 \begin_layout Description
5375 Syntax server-get-layout
5378 \begin_layout Subsection*
5379 LFUN_SERVER_GET_FILENAME
5382 \begin_layout Description
5383 Action Returns path and file name of the currently edited document.
5386 \begin_layout Description
5387 Syntax server-get-filename
5390 \begin_layout Subsection*
5391 LFUN_SERVER_GOTO_FILE_ROW
5394 \begin_layout Description
5395 Action Sets the cursor position based on the row number of generated TeX
5399 \begin_layout Description
5400 Notion This can be useful for DVI inverse-search or detection of the problematic
5401 line from LaTeX compilation.
5402 Note that before this function can be used export to LaTeX output must
5403 occur (in order to map the row numbers).
5406 \begin_layout Description
5407 Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
5410 \begin_layout Description
5411 Params <FILE>: the filename.
5412 Environment variables are expanded in the path.
5413 In case this LFUN does not work make sure you are giving correct path to
5415 \begin_inset Newline newline
5418 If the file is located inside LyX temporary directory it will be mapped
5419 back into the appropriate opened buffer (e.g.
5420 for the case of generated .tex file).
5421 .ext: extensions will be automatically replaced by .lyx.
5422 <ROW_NUMBER> The row number of the LaTeX file to which to go.
5425 \begin_layout Description
5426 Origin Edmar, 23 Dec 1998
5429 \begin_layout Subsection*
5433 \begin_layout Description
5434 Action Sends notify message about the last key-sequence to client.
5437 \begin_layout Description
5438 Notion This can be used to grab last key-sequence used inside the LyX window.
5439 See also Debug extensions section in Additional features manual.
5442 \begin_layout Description
5443 Syntax server-notify
5446 \begin_layout Subsection*
5450 \begin_layout Description
5451 Action Sets the cursor position based on the editing area coordinates (similar
5452 as clicking on that point with left mouse button).
5455 \begin_layout Description
5456 Syntax server-set-xy <X> <Y>
5459 \begin_layout Subsection*
5463 \begin_layout Description
5464 Action Returns the coordinates of cursor position in the editing area.
5467 \begin_layout Description
5468 Syntax server-get-xy
5471 \begin_layout Subsection*
5475 \begin_layout Description
5476 Action Generates the code (literate programming).
5479 \begin_layout Description
5480 Notion Latex file with extension
5482 literate_extension is generated.
5485 build_command (with a default of``make'') to generate the code and
5487 build_error_filter to process the compilation error messages.
5488 \begin_inset Newline newline
5491 In case you want to process your literate file with a script, or some other
5492 program, just insert in your lyxrc file an entry with:
5493 \begin_inset Newline newline
5498 build_command "my_script my_arguments"
5499 \begin_inset Newline newline
5504 build_error_filter differs from the
5506 literate_error_filter only in that the former will identify error messages
5510 \begin_layout Description
5511 Syntax build-program
5514 \begin_layout Subsection*
5515 LFUN_BUFFER_AUTO_SAVE
5518 \begin_layout Description
5519 Action Saves the current buffer to a temporary file.
5522 \begin_layout Description
5523 Notion Saves the current buffer to a file named "#filename#".
5524 This LFUN is called automatically by LyX, to "autosave" the current buffer.
5527 \begin_layout Description
5528 Syntax buffer-auto-save
5531 \begin_layout Subsection*
5532 LFUN_BUFFER_CHILD_OPEN
5535 \begin_layout Description
5536 Action Loads the given child document.
5539 \begin_layout Description
5540 Notion The current document is treated as a parent.
5543 \begin_layout Description
5544 Syntax buffer-child-open <FILE>
5547 \begin_layout Description
5548 Params <FILE>: Filename of the child.
5549 The directory of the parent is assumed by default.
5552 \begin_layout Description
5553 Origin Ale, 28 May 1997
5556 \begin_layout Subsection*
5560 \begin_layout Description
5561 Action Runs chktex for the current document.
5564 \begin_layout Description
5565 Syntax buffer-chktex
5568 \begin_layout Description
5569 Origin Asger, 30 Oct 1997
5572 \begin_layout Subsection*
5573 LFUN_BUFFER_TOGGLE_COMPRESSION
5576 \begin_layout Description
5577 Action Toggles compression of the current document on/off.
5580 \begin_layout Description
5581 Syntax buffer-toggle-compression
5584 \begin_layout Description
5585 Origin bpeng, 27 Apr 2006
5588 \begin_layout Subsection*
5592 \begin_layout Description
5593 Action Closes the current buffer.
5596 \begin_layout Description
5597 Notion Closes the current buffer, asking whether to save it, etc, if the
5598 buffer has been modified.
5601 \begin_layout Description
5605 \begin_layout Subsection*
5606 LFUN_BUFFER_CLOSE_ALL
5609 \begin_layout Description
5610 Action Closes all buffers.
5613 \begin_layout Description
5614 Notion Closes all buffers, asking whether to save it, etc, if a buffer has
5618 \begin_layout Description
5619 Syntax buffer-close-all
5622 \begin_layout Subsection*
5626 \begin_layout Description
5627 Action Exports the current buffer (document) to the given format.
5630 \begin_layout Description
5631 Syntax buffer-export <FORMAT>
5634 \begin_layout Description
5635 Params <FORMAT> is either "custom" or one of the formats which you can find
5636 in Tools->Preferences->File formats->Format.
5637 Usual format you will enter is "pdf2" (pdflatex), "pdflatex" (plain tex
5638 for pdflatex) or "ps" for postscript.
5639 \begin_inset Newline newline
5642 In case of "custom" you will be asked for a format you want to start from
5643 and for the command that you want to apply to this format.
5644 Internally the control is then passed to LFUN_BUFFER_EXPORT_CUSTOM.
5647 \begin_layout Description
5648 Origin Lgb, 29 Jul 1997
5651 \begin_layout Subsection*
5652 LFUN_BUFFER_EXPORT_CUSTOM
5655 \begin_layout Description
5656 Action Exports the current buffer (document) from the given format using
5657 the given command on it.
5660 \begin_layout Description
5661 Syntax buffer-export-custom <FORMAT> <COMMAND>
5664 \begin_layout Description
5665 Params <FORMAT> format to start from (LyX will care to produce such intermediate
5667 \begin_inset Newline newline
5670 <COMMAND> this command will be launched on the file.
5671 Note that you can use "$$FName" string to qualify the intermediate file.
5674 \begin_layout Description
5675 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
5678 \begin_layout Description
5679 Origin leeming, 27 Mar 2004
5682 \begin_layout Subsection*
5686 \begin_layout Description
5687 Action Prints the current document.
5690 \begin_layout Description
5691 Notion Many settings can be given via the preferences dialog.
5694 \begin_layout Description
5695 Syntax buffer-print <TARGET> <TARGET-NAME> <COMMAND>
5698 \begin_layout Description
5699 Params <TARGET> is either "printer" or "file".
5700 \begin_inset Newline newline
5703 <TARGER-NAME> is either "default" or file name or printer name.
5704 \begin_inset Newline newline
5707 <COMMAND> command ensuring the printing job.
5710 \begin_layout Description
5711 Sample buffer-print file "/trash/newfile1.ps" "dvips"
5714 \begin_layout Description
5715 Origin leeming, 28 Mar 2004
5718 \begin_layout Subsection*
5722 \begin_layout Description
5723 Action Import a given file as a lyx document.
5726 \begin_layout Description
5727 Notion File can be imported iff lyx file format is (transitively) reachable
5728 via defined convertors in preferences.
5729 Look into File->Import menu to get an idea of the currently active import
5733 \begin_layout Description
5734 Syntax buffer-import <FORMAT> [<FILE>]
5737 \begin_layout Description
5738 Origin Asger, 24 Jul 1998
5741 \begin_layout Subsection*
5745 \begin_layout Description
5746 Action Creates a new buffer (that is, document).
5749 \begin_layout Description
5750 Notion Implicit path can be set in Preferences dialog.
5753 \begin_layout Description
5754 Syntax buffer-new [<FILE>]
5757 \begin_layout Description
5758 Params <FILE>: filename of created file with absolute path.
5761 \begin_layout Subsection*
5762 LFUN_BUFFER_NEW_TEMPLATE
5765 \begin_layout Description
5766 Action Creates a new buffer (that is, document) from a template.
5769 \begin_layout Description
5770 Notion Path for new files and templates can be set in Preferences dialog.
5771 Template will be asked for via Open-dialog.
5774 \begin_layout Description
5775 Syntax buffer-new-template [<FILE>]
5778 \begin_layout Description
5779 Params <FILE>: filename of created file with absolute path.
5782 \begin_layout Subsection*
5786 \begin_layout Description
5787 Action Reverts opened document.
5790 \begin_layout Description
5791 Syntax buffer-reload
5794 \begin_layout Description
5795 Origin Asger, 2 Feb 1997
5798 \begin_layout Subsection*
5802 \begin_layout Description
5803 Action Switch to the given buffer.
5806 \begin_layout Description
5807 Notion This is useful also in case you need simultaneously more views of
5808 the edited document in different LyX windows.
5811 \begin_layout Description
5812 Syntax buffer-new-template <BUFFER>
5815 \begin_layout Description
5816 Params <BUFFER>: already opened document which is to be shown.
5819 \begin_layout Subsection*
5820 LFUN_BUFFER_TOGGLE_READ_ONLY
5823 \begin_layout Description
5824 Action Toggle editing mode of the current document between read/write and
5828 \begin_layout Description
5829 Notion In the ->Readonly mode checks-in/commits the data if the file is
5830 under version control.
5831 In the Readonly-> mode checkouts the data from repository.
5832 \begin_inset Newline newline
5835 If these operations fail, buffer won't be toggled.
5838 \begin_layout Description
5839 Syntax buffer-toggle-read-only
5842 \begin_layout Description
5843 Origin Lgb, 27 May 1997
5846 \begin_layout Subsection*
5850 \begin_layout Description
5851 Action Displays current buffer in chosen format.
5854 \begin_layout Description
5855 Notion Displays the contents of the current buffer in the chosen format,
5856 for example, PDF or DVI.
5857 This runs the necessary converter, calls the defined viewer, and so forth.
5860 \begin_layout Description
5861 Syntax buffer-view [<FORMAT>]
5864 \begin_layout Description
5865 Params <FORMAT>: The format to display, where this is one of the formats
5866 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
5867 If no format is given, the default format as specified in the same dialog
5871 \begin_layout Subsection*
5875 \begin_layout Description
5876 Action Exports the current document and put the result into the temporary
5880 \begin_layout Description
5881 Notion In case you are already viewing the exported document (see LFUN_BUFFER_VI
5882 EW) the output will be rewriten - updated.
5883 This is useful in case your viewer is able to detect such changes (e.g.
5884 ghostview for postscript).
5887 \begin_layout Description
5888 Syntax buffer-update [<FORMAT>]
5891 \begin_layout Description
5892 Params <FORMAT>: The format to display, where this is one of the formats
5893 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
5894 If no format is given, the default format as specified in the same dialog
5898 \begin_layout Description
5899 Origin Dekel, 5 Aug 2000
5902 \begin_layout Subsection*
5906 \begin_layout Description
5907 Action Saves the current buffer.
5910 \begin_layout Description
5911 Notion Saves the current buffer to disk, using the filename that is already
5912 associated with the buffer, asking for one if none is yet assigned.
5915 \begin_layout Description
5919 \begin_layout Subsection*
5920 LFUN_BUFFER_WRITE_AS
5923 \begin_layout Description
5924 Action Rename and save current buffer.
5927 \begin_layout Description
5928 Syntax buffer-write-as <FILENAME>
5931 \begin_layout Description
5932 Params <FILENAME>: New name of the buffer/file.
5933 A relative path is with respect to the original location of the buffer/file.
5936 \begin_layout Subsection*
5937 LFUN_BUFFER_WRITE_ALL
5940 \begin_layout Description
5941 Action Save all changed documents.
5944 \begin_layout Description
5945 Syntax buffer-write-all
5948 \begin_layout Description
5949 Origin rgh, gpothier 6 Aug 2007
5952 \begin_layout Subsection*
5956 \begin_layout Description
5957 Action Switch to the next opened document.
5960 \begin_layout Description
5961 Notion Note that this does not necessarily mean next in tabbar (for full
5962 list see View menu).
5965 \begin_layout Description
5969 \begin_layout Subsection*
5970 LFUN_BUFFER_PREVIOUS
5973 \begin_layout Description
5974 Action Switch to the previous opened document.
5977 \begin_layout Description
5978 Syntax buffer-previous
5981 \begin_layout Subsection*
5982 LFUN_MASTER_BUFFER_UPDATE
5985 \begin_layout Description
5986 Action When run from a child document, this updates (exports) document built
5987 from the master buffer, if available.
5990 \begin_layout Description
5991 Syntax master-buffer-update [<FORMAT>]
5994 \begin_layout Description
5995 Params <FORMAT>: The format to display, where this is one of the formats
5996 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
5997 If no format is given, the default format as specified in the same dialog
6001 \begin_layout Description
6002 Origin Tommaso, 20 Sep 2007
6005 \begin_layout Subsection*
6006 LFUN_MASTER_BUFFER_VIEW
6009 \begin_layout Description
6010 Action When run from a child document, this command shows a preview built
6011 from the master buffer, if available.
6014 \begin_layout Description
6015 Syntax master-buffer-view [<FORMAT>]
6018 \begin_layout Description
6019 Params <FORMAT>: The format to display, where this is one of the formats
6020 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
6021 If no format is given, the default format as specified in the same dialog
6025 \begin_layout Description
6026 Origin Tommaso, 20 Sep 2007
6029 \begin_layout Subsection*
6030 LFUN_BUFFER_LANGUAGE
6033 \begin_layout Description
6034 Action Set language of the current document.
6037 \begin_layout Description
6038 Syntax buffer-language <LANG>
6041 \begin_layout Description
6042 Params <LANG>: language name.
6043 See lib/languages for list.
6046 \begin_layout Description
6047 Origin leeming, 30 Mar 2004
6050 \begin_layout Subsection*
6051 LFUN_BUFFER_SAVE_AS_DEFAULT
6054 \begin_layout Description
6055 Action Save the current document settings as default.
6058 \begin_layout Description
6059 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
6062 \begin_layout Description
6063 Syntax buffer-save-as-default [<ARGS>]
6066 \begin_layout Description
6067 Params <ARGS>: contains the particular settings to be saved.
6068 They obey the syntax you can find in document header of usual .lyx file.
6071 \begin_layout Description
6072 Origin leeming, 30 Mar 2004
6075 \begin_layout Subsection*
6076 LFUN_BUFFER_PARAMS_APPLY
6079 \begin_layout Description
6080 Action Apply the given settings to the current document.
6083 \begin_layout Description
6084 Syntax buffer-params-apply [<ARGS>]
6087 \begin_layout Description
6088 Params <ARGS>: contains the particular settings to be saved.
6089 They obey the syntax you can find in document header of usual .lyx file.
6092 \begin_layout Description
6093 Origin leeming, 30 Mar 2004
6096 \begin_layout Subsection*
6100 \begin_layout Description
6101 Action Inserts another LyX file.
6104 \begin_layout Description
6105 Syntax file-insert [<FILE>]
6108 \begin_layout Description
6109 Params <FILE>: Filename to be inserted.
6112 \begin_layout Subsection*
6113 LFUN_FILE_INSERT_PLAINTEXT
6116 \begin_layout Description
6117 Action Inserts plain text file.
6120 \begin_layout Description
6121 Syntax file-insert-plaintext [<FILE>]
6124 \begin_layout Description
6125 Params <FILE>: Filename to be inserted.
6128 \begin_layout Description
6129 Origin CFO-G, 19 Nov 1997
6132 \begin_layout Subsection*
6133 LFUN_FILE_INSERT_PLAINTEXT_PARA
6136 \begin_layout Description
6137 Action Inserts plain text file as paragraph (i.e.
6141 \begin_layout Description
6142 Syntax file-insert-plaintext-para [<FILE>]
6145 \begin_layout Description
6146 Params <FILE>: Filename to be inserted.
6149 \begin_layout Description
6150 Origin Levon, 14 Feb 2001
6153 \begin_layout Subsection*
6157 \begin_layout Description
6158 Action Open LyX document.
6161 \begin_layout Description
6162 Syntax file-open [<FILE>]
6165 \begin_layout Description
6166 Params <FILE>: Filename to be opened.
6169 \begin_layout Subsection*
6173 \begin_layout Description
6174 Action Executes a command defined in a .def file.
6177 \begin_layout Description
6178 Notion The definitions are by default read from lib/commands/default.def.
6179 \begin_inset Newline newline
6182 A .def file allows to define a command with
6184 define "<NAME>" "<LFUN>" where <NAME> is the name of the new command and
6185 <LFUN> is the lfun code to be executed (see e.g.
6186 LFUN_COMMAND_SEQUENCE).
6189 def_file "FileName" allows to include another .def file.
6190 \begin_inset Newline newline
6193 This is particularly useful in connection with toolbar buttons: Since the
6194 name of the button image for this lfun is lib/images/commands/<NAME>.png
6195 this is the way to assign an image to a complex command-sequence.
6198 \begin_layout Description
6202 \begin_layout Description
6203 Params <NAME>: Name of the command that must be called.
6206 \begin_layout Description
6207 Origin broider, 2 Oct 2007
6210 \begin_layout Subsection*
6214 \begin_layout Description
6215 Action Simulate halting Meta key (Alt key on PCs).
6218 \begin_layout Description
6219 Notion Used for buffer editation not for GUI control.
6222 \begin_layout Description
6226 \begin_layout Subsection*
6230 \begin_layout Description
6231 Action Cancels sequence prepared by LFUN_META_PREFIX .
6234 \begin_layout Description
6238 \begin_layout Subsection*
6239 LFUN_COMMAND_EXECUTE
6242 \begin_layout Description
6243 Action Opens the minibuffer toolbar so that the user can type in there.
6246 \begin_layout Description
6247 Notion Usually bound to M-x shortcut.
6250 \begin_layout Description
6251 Syntax command-execute
6254 \begin_layout Subsection*
6258 \begin_layout Description
6259 Action Return the current key sequence and available options as a string.
6262 \begin_layout Description
6263 Notion No options are added if no current map exists.
6264 \begin_inset Newline newline
6267 This is probably usable only with connection to lyxserver.
6270 \begin_layout Description
6271 Syntax command-prefix
6274 \begin_layout Subsection*
6275 LFUN_COMMAND_SEQUENCE
6278 \begin_layout Description
6279 Action Run more commands (LFUN and its parameters) in a sequence.
6282 \begin_layout Description
6283 Syntax command-sequence <CMDS>
6286 \begin_layout Description
6287 Params <CMDS>: Sequence of commands separated by semicolons.
6290 \begin_layout Description
6291 Sample command-sequence cut; ert-insert; self-insert
6293 ; paste; self-insert {}; inset-toggle;
6296 \begin_layout Description
6297 Origin Andre, 11 Nov 1999
6300 \begin_layout Subsection*
6301 LFUN_COMMAND_ALTERNATIVES
6304 \begin_layout Description
6305 Action Runs the first listed command that is enabled.
6308 \begin_layout Description
6309 Notion This can be used to bind multiple functions to a single key, and
6310 then which one is used will depend upon the context.
6313 \begin_layout Description
6314 Syntax command-alternatives <CMDS>
6317 \begin_layout Description
6318 Params <CMDS>: Sequence of commands separated by semicolons.
6321 \begin_layout Description
6322 Sample command-alternatives completion-accept;cell-forward
6325 \begin_layout Description
6326 Origin rgh, 24 September 2008
6329 \begin_layout Subsection*
6333 \begin_layout Description
6334 Action Shows message in statusbar (for script purposes).
6337 \begin_layout Description
6338 Syntax message <STRING>
6341 \begin_layout Description
6342 Origin Lgb, 8 Apr 2001
6345 \begin_layout Subsection*
6346 LFUN_PREFERENCES_SAVE
6349 \begin_layout Description
6350 Action Save user preferences.
6353 \begin_layout Description
6354 Syntax preferences-save
6357 \begin_layout Description
6358 Origin Lgb, 27 Nov 1999
6361 \begin_layout Subsection*
6365 \begin_layout Description
6366 Action Reconfigure the automatic settings.
6369 \begin_layout Description
6373 \begin_layout Description
6374 Origin Asger, 14 Feb 1997
6377 \begin_layout Subsection*
6381 \begin_layout Description
6382 Action Apply the given settings to user preferences.
6385 \begin_layout Description
6386 Syntax lyxrc-apply <SETTINGS>
6389 \begin_layout Description
6390 Params <SETTINGS>: settings which are to be set.
6391 Take a look into ~/.lyx/preferences to get an idea which commands to use
6393 lyx::LyXRC::LyXRCTags has the list of possible commands.
6396 \begin_layout Subsection*
6397 LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
6400 \begin_layout Description
6401 Action Determine whether keep cursor inside the editing window regardless
6402 the scrollbar movement.
6405 \begin_layout Description
6406 Syntax toggle-cursor-follows-scrollbar
6409 \begin_layout Description
6410 Origin ARRae, 2 Dec 1997
6413 \begin_layout Subsection*
6417 \begin_layout Description
6418 Action Set the given LyX color to the color defined by the X11 name given.
6421 \begin_layout Description
6422 Notion A new color entry is created if the color is unknown.
6423 Color names can be stored as a part of user settings.
6426 \begin_layout Description
6427 Syntax set-color <LYX_NAME> <X11_NAME>
6430 \begin_layout Description
6431 Origin SLior, 11 Jun 2000
6434 \begin_layout Subsection*
6438 \begin_layout Description
6439 Action Count the statistics (number of words and characters) in the document
6440 or in the given selection.
6443 \begin_layout Description
6444 Notion Note that this function gives the number of words/chars written,
6445 not the number of characters which will be typeset.
6448 \begin_layout Description
6452 \begin_layout Description
6453 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
6456 \begin_layout Subsection*
6457 LFUN_COMPLETION_INLINE
6460 \begin_layout Description
6461 Action Show the inline completion at the cursor position.
6464 \begin_layout Description
6465 Syntax completion-inline
6468 \begin_layout Description
6469 Origin sts, Feb 19 2008
6472 \begin_layout Subsection*
6473 LFUN_COMPLETION_POPUP
6476 \begin_layout Description
6477 Action Show the completion popup at the cursor position.
6480 \begin_layout Description
6481 Syntax completion-popup
6484 \begin_layout Description
6485 Origin sts, Feb 19 2008
6488 \begin_layout Subsection*
6489 LFUN_COMPLETION_COMPLETE
6492 \begin_layout Description
6493 Action Try to complete the word or command at the cursor position.
6496 \begin_layout Description
6500 \begin_layout Description
6501 Origin sts, Feb 19 2008
6504 \begin_layout Subsection*
6505 LFUN_COMPLETION_CANCEL
6508 \begin_layout Description
6509 Action Try to cancel completion, either the popup or the inline completion.
6512 \begin_layout Description
6513 Syntax completion-cancel
6516 \begin_layout Description
6517 Origin sts, Sep 07 2008
6520 \begin_layout Subsection*
6521 LFUN_COMPLETION_ACCEPT
6524 \begin_layout Description
6525 Action Accept suggested completion.
6528 \begin_layout Description
6529 Syntax completion-accept
6532 \begin_layout Description
6533 Origin sanda, Sep 08 2008
6536 \begin_layout Subsection*
6540 \begin_layout Description
6541 Action Add a branch to the buffer's BranchList.
6544 \begin_layout Description
6545 Syntax branch-add <BRANCH>
6548 \begin_layout Description
6549 Params <BRANCH>: Name of the branch to add
6552 \begin_layout Description
6553 Origin spitz, 7 Jul 2009
6556 \begin_layout Subsection*
6557 LFUN_BRANCH_ACTIVATE
6560 \begin_layout Description
6561 Action Activate the branch.
6564 \begin_layout Description
6565 Syntax branch-activate <BRANCH>
6568 \begin_layout Description
6569 Params <BRANCH>: The branch to activate
6572 \begin_layout Description
6573 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
6574 \begin_inset Newline newline
6577 could be used to export a pdf with the answers branch included without one's
6578 having to open LyX and activate the branch manually.
6581 \begin_layout Description
6582 Origin rgh, 27 May 2008
6585 \begin_layout Subsection*
6586 LFUN_BRANCH_DEACTIVATE
6589 \begin_layout Description
6590 Action De-activate the branch.
6593 \begin_layout Description
6594 Syntax branch-deactivate <BRANCH>
6597 \begin_layout Description
6598 Params <BRANCH>: The branch to deactivate
6601 \begin_layout Description
6602 Origin rgh, 27 May 2008
6605 \begin_layout Subsection*
6606 LFUN_BRANCHES_RENAME
6609 \begin_layout Description
6610 Action Rename all branches of a given name in a document.
6613 \begin_layout Description
6614 Syntax branches-rename <OLDNAME> <NEWNAME>
6617 \begin_layout Description
6618 Params <OLDNAME>: Current name of the branch to be renamed <NEWNAME>: New
6622 \begin_layout Description
6623 Origin spitz, 9 Jul 2009
6626 \begin_layout Subsection*
6627 LFUN_BRANCH_ADD_INSERT
6630 \begin_layout Description
6631 Action Create new branch and directly put the branch inset into the document.
6634 \begin_layout Description
6635 Syntax branch-add-insert [<NAME>]
6638 \begin_layout Description
6639 Params <NAME>: Branch name.
6640 If it is not specified, you will be asked.
6643 \begin_layout Description
6644 Origin sanda, 10 Jul 2009
6647 \begin_layout Subsection*
6648 LFUN_LABEL_COPY_AS_REF
6651 \begin_layout Description
6652 Action Copies the label at the cursor as a cross-reference to be pasted
6656 \begin_layout Description
6657 Syntax copy-label-as-reference <LABEL>
6660 \begin_layout Description
6661 Params <LABEL>: The label to copy (for multi-line math)
6664 \begin_layout Description
6665 Origin sts, 16 Nov 2008
6668 \begin_layout Subsection*
6669 LFUN_LABEL_INSERT_AS_REF
6672 \begin_layout Description
6673 Action Inserts the label as a cross-reference at the position of the cursor.
6676 \begin_layout Description
6677 Syntax label-insert-as-reference
6680 \begin_layout Description
6681 Origin vfr, 7 Apr 2009
6684 \begin_layout Subsection*
6688 \begin_layout Description
6689 Action Increases the zoom of the screen fonts.
6692 \begin_layout Description
6693 Syntax buffer-zoom-in [<ZOOM>]
6696 \begin_layout Description
6697 Params <ZOOM>: The zoom in %, the default is 20.
6700 \begin_layout Description
6701 Origin vfr, 30 Mar 2009
6704 \begin_layout Subsection*
6705 LFUN_BUFFER_ZOOM_OUT
6708 \begin_layout Description
6709 Action Decreases the zoom of the screen fonts.
6712 \begin_layout Description
6713 Syntax buffer-zoom-out [<ZOOM>]
6716 \begin_layout Description
6717 Params <ZOOM>: The zoom in %, the default is 20.
6720 \begin_layout Description
6721 Origin vfr, 30 Mar 2009
6724 \begin_layout Subsection*
6728 \begin_layout Description
6729 Action Selects the whole section.
6732 \begin_layout Description
6733 Notion The cursor should be in a section heading before calling this lfun.
6736 \begin_layout Description
6737 Syntax section-select
6740 \begin_layout Description
6741 Origin vfr, 05 May 2009
6744 \begin_layout Subsection*
6745 LFUN_GRAPHICS_RELOAD
6748 \begin_layout Description
6749 Action Reloads the image if necessary.
6752 \begin_layout Description
6753 Syntax graphics-reload
6756 \begin_layout Description
6757 Origin vfr, 10 Aug 2009