1 #LyX 2.1 created this file. For more info see http://www.lyx.org/
7 \renewcommand{\descriptionlabel}[1]{\hspace\labelsep\upshape\bfseries #1:}
8 \renewenvironment{description}{\list{}{%
9 \setlength{\itemsep}{-2pt}
10 \advance\leftmargini6\p@ \itemindent-12\p@
11 \labelwidth\z@ \let\makelabel\descriptionlabel}%
16 \use_default_options false
17 \maintain_unincluded_children false
19 \language_package default
24 \font_typewriter default
26 \font_default_family default
27 \use_non_tex_fonts false
33 \default_output_format default
35 \bibtex_command default
36 \index_command default
37 \paperfontsize default
42 \use_package amsmath 1
43 \use_package amssymb 1
46 \use_package mathdots 0
47 \use_package mathtools 0
49 \use_package stackrel 0
50 \use_package stmaryrd 0
51 \use_package undertilde 0
53 \cite_engine_type default
57 \paperorientation portrait
71 \paragraph_separation indent
72 \paragraph_indentation default
73 \quotes_language english
76 \paperpagestyle default
77 \tracking_changes false
86 \begin_layout Section*
87 LFUNs documentation automatically generated 2013-08-04
90 \begin_layout Standard
94 \begin_layout Plain Layout
104 \begin_inset VSpace 1cm
110 \begin_layout Subsection*
114 \begin_layout Description
115 Action Adds an acute accent to the next character typed.
118 \begin_layout Description
122 \begin_layout Subsection*
126 \begin_layout Description
127 Action Adds a breve accent to the next character typed.
130 \begin_layout Description
134 \begin_layout Subsection*
138 \begin_layout Description
139 Action Adds a caron to the next character typed.
142 \begin_layout Description
146 \begin_layout Subsection*
150 \begin_layout Description
151 Action Adds a cedilla to the next character typed.
154 \begin_layout Description
155 Syntax accent-cedilla
158 \begin_layout Subsection*
162 \begin_layout Description
163 Action Adds a circle accent to the next character typed.
166 \begin_layout Description
170 \begin_layout Subsection*
171 LFUN_ACCENT_CIRCUMFLEX
174 \begin_layout Description
175 Action Adds a circumflex to the next character typed.
178 \begin_layout Description
179 Syntax accent-circumflex
182 \begin_layout Subsection*
186 \begin_layout Description
187 Action Adds a dot accent to the next character typed.
190 \begin_layout Description
194 \begin_layout Subsection*
198 \begin_layout Description
199 Action Adds a grave accent to the next character typed.
202 \begin_layout Description
206 \begin_layout Subsection*
207 LFUN_ACCENT_HUNGARIAN_UMLAUT
210 \begin_layout Description
211 Action Adds a Hungarian umlaut to the next character typed.
214 \begin_layout Description
218 \begin_layout Subsection*
222 \begin_layout Description
223 Action Adds a macron to the next character typed.
226 \begin_layout Description
230 \begin_layout Subsection*
234 \begin_layout Description
235 Action Adds an ogonek accent to the next character typed.
238 \begin_layout Description
242 \begin_layout Subsection*
246 \begin_layout Description
247 Action Adds a tie over the next two character typed.
250 \begin_layout Description
251 Notion The following char will finish the tie.
254 \begin_layout Description
258 \begin_layout Subsection*
262 \begin_layout Description
263 Action Adds a tilde over the next character typed.
266 \begin_layout Description
270 \begin_layout Subsection*
274 \begin_layout Description
275 Action Adds an umlaut over the next character typed.
278 \begin_layout Description
282 \begin_layout Subsection*
286 \begin_layout Description
287 Action Adds a bar under the next character typed.
290 \begin_layout Description
291 Syntax accent-underbar
294 \begin_layout Subsection*
298 \begin_layout Description
299 Action Adds a dot under the next character typed.
302 \begin_layout Description
303 Syntax accent-underdot
306 \begin_layout Subsection*
310 \begin_layout Description
311 Action Inserts a caption inset.
314 \begin_layout Description
315 Syntax caption-insert
318 \begin_layout Description
319 Origin Lgb, 18 Jul 2000
322 \begin_layout Subsection*
326 \begin_layout Description
327 Action Inserts the current date.
330 \begin_layout Description
331 Syntax date-insert [<ARG>]
334 \begin_layout Description
335 Params <ARG>: Format of date.
336 The default value (%x) can be set in Preferences->Date format.
337 For possible formats see manual page of strftime function.
340 \begin_layout Description
341 Origin jdblair, 31 Jan 2000
344 \begin_layout Subsection*
348 \begin_layout Description
349 Action Inserts a footnote inset.
352 \begin_layout Description
353 Syntax footnote-insert
356 \begin_layout Description
357 Origin Jug, 7 Mar 2000
360 \begin_layout Subsection*
364 \begin_layout Description
365 Action Inserts an ERT inset.
368 \begin_layout Description
372 \begin_layout Description
373 Origin Jug, 18 Feb 2000
376 \begin_layout Subsection*
380 \begin_layout Description
381 Action Inserts a float inset.
384 \begin_layout Description
385 Syntax float-insert <TYPE>
388 \begin_layout Description
389 Params <TYPE>: type of float depends on the used textclass.
390 Usually "algorithm", "table", "figure" parameters can be given.
393 \begin_layout Description
394 Origin Lgb, 27 Jun 2000
397 \begin_layout Subsection*
398 LFUN_FLOAT_WIDE_INSERT
401 \begin_layout Description
402 Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
405 \begin_layout Description
406 Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
409 \begin_layout Description
410 Syntax float-wide-insert <TYPE>
413 \begin_layout Description
414 Params <TYPE>: type of float depends on the used textclass.
415 Usually "algorithm", "table", "figure" parameters can be given.
418 \begin_layout Description
419 Origin Lgb, 31 Oct 2001
422 \begin_layout Subsection*
423 LFUN_FLOAT_LIST_INSERT
426 \begin_layout Description
427 Action Inserts the list of floats in the document.
430 \begin_layout Description
431 Syntax float-list-insert <TYPE>
434 \begin_layout Description
435 Params <TYPE>: type of float depends on the used textclass.
436 Usually "algorithm", "table", "figure" parameters can be given.
439 \begin_layout Description
440 Origin Lgb, 3 May 2001
443 \begin_layout Subsection*
447 \begin_layout Description
448 Action Inserts floats wrapped by the text around.
451 \begin_layout Description
452 Syntax wrap-insert <TYPE>
455 \begin_layout Description
456 Params <TYPE>: table|figure
459 \begin_layout Description
460 Origin Dekel, 7 Apr 2002
463 \begin_layout Subsection*
467 \begin_layout Description
468 Action Inserts an argument (short title) inset.
471 \begin_layout Description
472 Syntax argument-insert <argument nr>
475 \begin_layout Description
476 Params <argument nr>: see layout declarations
479 \begin_layout Description
480 Origin vermeer, 12 Aug 2002
483 \begin_layout Subsection*
487 \begin_layout Description
488 Action Inserts a new page.
491 \begin_layout Description
492 Syntax newpage-insert <ARG>
495 \begin_layout Description
496 Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
499 \begin_layout Description
500 Origin uwestoehr, 24 Nov 2007
503 \begin_layout Subsection*
504 LFUN_MARGINALNOTE_INSERT
507 \begin_layout Description
508 Action Inserts a marginal note.
511 \begin_layout Description
512 Syntax marginalnote-insert
515 \begin_layout Description
516 Origin Lgb, 26 Jun 2000
519 \begin_layout Subsection*
523 \begin_layout Description
524 Action Inserts a single unicode character.
527 \begin_layout Description
528 Syntax unicode-insert <CHAR>
531 \begin_layout Description
532 Params <CHAR>: The character to insert, given as its code point, in hexadecimal.
535 \begin_layout Description
536 Sample unicode-insert 0x0100
539 \begin_layout Description
540 Origin Lgb, 22 Oct 2006
543 \begin_layout Subsection*
547 \begin_layout Description
548 Action Inserts a new listings inset.
551 \begin_layout Description
552 Syntax listing-insert
555 \begin_layout Description
556 Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
559 \begin_layout Subsection*
563 \begin_layout Description
564 Action Inserts a new preview inset.
567 \begin_layout Description
568 Syntax preview-insert
571 \begin_layout Description
572 Origin vfr, 28 Mar 2010
575 \begin_layout Subsection*
579 \begin_layout Description
580 Action Insert a tab into a listings inset.
583 \begin_layout Description
584 Notion It also works on a selection.
587 \begin_layout Description
591 \begin_layout Description
592 Origin vfr, Sep 30 2008
595 \begin_layout Subsection*
599 \begin_layout Description
600 Action Delete a tab or up to an equivalent amount of spaces from a listings
604 \begin_layout Description
605 Notion It also works on a selection - it removes a tab or spaces from the
606 beginning of each line spanned by the selection.
607 This is useful if you want to indent/unindent multiple lines in one action.
610 \begin_layout Description
614 \begin_layout Description
615 Origin vfr, Sep 30 2008
618 \begin_layout Subsection*
622 \begin_layout Description
623 Action Inserts quotes according to the type and quote-language preference.
626 \begin_layout Description
627 Notion Currently English, Swedish, German, Polish, French, Danish quotes
631 \begin_layout Description
632 Syntax quote-insert [<TYPE>]
635 \begin_layout Description
636 Params <TYPE>: 'single' for single quotes, otherwise double quotes will
640 \begin_layout Subsection*
644 \begin_layout Description
645 Action Displays shortcuts, lyxrc, package and textclass availability and
646 menu information in a non-editable boxed InsetText.
649 \begin_layout Description
650 Notion Apart from lfun arguments you can use the following method:
651 \begin_inset Newline newline
655 input the type and argument of this inset, e.g.
656 "menu paste", in the work area.
657 \begin_inset Newline newline
661 select the text and run info-insert lfun.
664 \begin_layout Description
665 Syntax info-insert <TYPE> <ARG>
668 \begin_layout Description
669 Params <TYPE>: shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|buffer
670 \begin_inset Newline newline
673 <ARG>: argument for a given type.
674 Look into InsetInfo.h for detailed description.
675 \begin_inset Newline newline
678 shortcut[s]: name of lfun (e.g math-insert
681 \begin_inset Newline newline
684 lyxrc: name of rc_entry (e.g.
686 \begin_inset Newline newline
689 lyxinfo: "version" - used version of LyX
690 \begin_inset Newline newline
693 package: name of latex package (e.g.
695 \begin_inset Newline newline
698 textclass: name of textclass (e.g.
700 \begin_inset Newline newline
703 menu: name of lfun used in menu
704 \begin_inset Newline newline
707 icon: icon of lfun used in toolbar
708 \begin_inset Newline newline
711 buffer: "name"|"path"|"class"|"vcs-tree-revision"| "vcs-revision"|"vcs-a
712 uthor"|"vcs-date"|"vcs-time"
715 \begin_layout Description
716 Sample command-sequence info-insert buffer path; info-insert buffer name
719 \begin_layout Description
720 Origin bpeng, 7 Oct 2007
723 \begin_layout Subsection*
727 \begin_layout Description
728 Action Inserts branch inset.
731 \begin_layout Description
732 Syntax branch-insert <BRANCH-NAME>
735 \begin_layout Description
736 Origin vermeer, 17 Aug 2003
739 \begin_layout Subsection*
743 \begin_layout Description
744 Action Inserts Box inset.
747 \begin_layout Description
748 Syntax box-insert [<TYPE>]
751 \begin_layout Description
752 Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
753 \begin_inset Newline newline
756 Framed is the default one.
759 \begin_layout Description
760 Origin vermeer, 7 Oct 2003
763 \begin_layout Subsection*
767 \begin_layout Description
768 Action Inserts CharStyle, Custom inset or XML short element.
771 \begin_layout Description
772 Notion Look into the Customization manual for more information about these
774 \begin_inset Newline newline
777 To make this command enabled the layout file for the document class you're
778 using has to load the character styles.
779 There are a few contained in the Logical Markup module.
780 You can also of course create some yourself.
781 \begin_inset Newline newline
784 For dissolving the element see LFUN_INSET_DISSOLVE.
787 \begin_layout Description
788 Syntax flex-insert Name
791 \begin_layout Description
792 Params Name: This name must be defined either in your layout file or imported
794 The definition is InsetLayout Name or InsetLayout <Flex:Name>.
795 The Flex: prefix is optional.
798 \begin_layout Description
799 Sample flex-insert Code
802 \begin_layout Subsection*
806 \begin_layout Description
807 Action Inserts the given string (accordingly to the correct keymap).
810 \begin_layout Description
811 Notion Automatically replace the currently selected text.
812 Depends on lyxrc settings "auto_region_delete".
815 \begin_layout Description
816 Syntax self-insert <STRING>
819 \begin_layout Subsection*
823 \begin_layout Description
824 Action Inserts one of horizontal space insets.
827 \begin_layout Description
828 Syntax space-insert <NAME> [<LEN>]
831 \begin_layout Description
832 Params <NAME>: normal, protected, visible, thin, quad, qquad, enspace, enskip,
833 negthinspace, negmedspace, negthickspace, hfill, hfill*, dotfill, hrulefill,
835 \begin_inset Newline newline
838 Only in math mode: med and thick.
839 \begin_inset Newline newline
842 <LEN>: length for custom spaces (hspace, hspace* for protected)
845 \begin_layout Description
846 Origin JSpitzm, 20 May 2003, Mar 17 2008
849 \begin_layout Subsection*
850 LFUN_HYPERLINK_INSERT
853 \begin_layout Description
854 Action Inserts hyperlinks into the document (clickable in pdf output).
857 \begin_layout Description
858 Notion Hyperlink target can be set via selection + hyperlink-insert function.
861 \begin_layout Description
862 Syntax href-insert [<TARGET>]
865 \begin_layout Description
866 Origin CFO-G, 21 Nov 1997
869 \begin_layout Subsection*
870 LFUN_SPECIALCHAR_INSERT
873 \begin_layout Description
874 Action Inserts various characters into the document.
877 \begin_layout Description
878 Syntax specialchar-insert <CHAR>
881 \begin_layout Description
882 Params <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots, end-of-sen
883 tence, menu-separator.
886 \begin_layout Description
887 Origin JSpitzm, 6 Dec 2007
890 \begin_layout Subsection*
894 \begin_layout Description
895 Action Inserts a subscript or superscript inset.
898 \begin_layout Description
899 Syntax script-insert <TYPE>
902 \begin_layout Description
903 Params <TYPE>: subscript|superscript
906 \begin_layout Description
907 Origin Georg, 23 Nov 2010
910 \begin_layout Subsection*
914 \begin_layout Description
915 Action Start (or remove) Appendix on the given cursor position.
918 \begin_layout Description
922 \begin_layout Description
923 Origin ettrich, 5 May 1998
926 \begin_layout Subsection*
930 \begin_layout Description
931 Action Inserts Index entry.
934 \begin_layout Description
935 Notion It automatically takes the word on the cursor position.
938 \begin_layout Description
939 Syntax index-insert [<TYPE:Name>]
942 \begin_layout Description
943 Params <TYPE:Name>: name of the index, if multiple indices are defined.
944 With an empty argument, the default index is selected.
947 \begin_layout Description
948 Origin leeming, 3 Aug 2000
951 \begin_layout Subsection*
955 \begin_layout Description
956 Action Inserts list of Index entries on a new page.
959 \begin_layout Description
960 Syntax index-print [<TYPE:Name>]
963 \begin_layout Description
964 Params <TYPE:Name>: name of the index, if multiple indices are defined.
965 With an empty argument, the default index is selected.
968 \begin_layout Description
969 Origin Lgb, 27 Feb 1997
972 \begin_layout Subsection*
976 \begin_layout Description
977 Action Inserts an IPA inset.
980 \begin_layout Description
984 \begin_layout Description
985 Origin spitz, 05 Mar 2012
988 \begin_layout Subsection*
992 \begin_layout Description
993 Action Only active in IPA inset.
996 \begin_layout Description
997 Notion Dummy function which is only active in a IPA inset.
998 It's used to toggle the IPA toolbar if the cursor moves into an IPA inset.
1001 \begin_layout Description
1005 \begin_layout Description
1006 Origin spitz, 20 May 2012
1009 \begin_layout Subsection*
1010 LFUN_IPAMACRO_INSERT
1013 \begin_layout Description
1014 Action Inserts special IPA macros into the document.
1017 \begin_layout Description
1018 Syntax ipamacro-insert <CHAR>
1021 \begin_layout Description
1022 Params <CHAR>: tone-falling, tone-rising, tone-high-rising, tone-low-rising,
1023 tone-high-rising-falling, deco bottomtiebar, deco toptiebar.
1026 \begin_layout Description
1027 Origin JSpitzm, 22 Aug 2012
1030 \begin_layout Subsection*
1034 \begin_layout Description
1035 Action Inserts Nomenclature entry.
1038 \begin_layout Description
1039 Notion It automatically takes the word on the cursor position if no symbol
1043 \begin_layout Description
1044 Syntax nomencl-insert [<SYMBOL>]
1047 \begin_layout Description
1048 Origin Ugras, 4 Nov 2006
1051 \begin_layout Subsection*
1052 LFUN_NOMENCLATURE_PRINT
1055 \begin_layout Description
1056 Action Inserts list of Nomenclature entries.
1059 \begin_layout Description
1060 Syntax nomenclature-print
1063 \begin_layout Description
1064 Origin Ugras, 4 Nov 2006
1067 \begin_layout Subsection*
1071 \begin_layout Description
1072 Action Inserts Note on the current cursor position, move selection inside
1076 \begin_layout Description
1077 Syntax note-insert [<TYPE>]
1080 \begin_layout Description
1081 Params <TYPE>: <Note|Greyedout|Comment> default: Note
1084 \begin_layout Subsection*
1088 \begin_layout Description
1089 Action Moves the cursor to the beginning of next Note inset.
1092 \begin_layout Description
1096 \begin_layout Subsection*
1100 \begin_layout Description
1101 Action Inserts phantom on the current cursor position, move selection inside
1105 \begin_layout Description
1106 Syntax phantom-insert [<TYPE>]
1109 \begin_layout Description
1110 Params <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
1113 \begin_layout Description
1114 Origin uwestoehr, 30 Jan 2009
1117 \begin_layout Subsection*
1121 \begin_layout Description
1122 Action Inserts a line break or new line.
1125 \begin_layout Description
1126 Syntax newline-insert [<ARG>]
1129 \begin_layout Description
1130 Params <ARG>: <newline|linebreak> default: newline
1133 \begin_layout Description
1134 Origin JSpitzm, 25 Mar 2008
1137 \begin_layout Subsection*
1141 \begin_layout Description
1142 Action Clears the selection.
1143 If no text is selected call LFUN_FINISHED_FORWARD.
1144 Inside math mode jumps out of the math inset.
1147 \begin_layout Description
1151 \begin_layout Description
1152 Origin Lgb, 17 May 2001
1155 \begin_layout Subsection*
1159 \begin_layout Description
1160 Action Moves the cursor one line in downward direction.
1163 \begin_layout Description
1167 \begin_layout Subsection*
1171 \begin_layout Description
1172 Action Moves the cursor one line in upward direction.
1175 \begin_layout Description
1179 \begin_layout Subsection*
1183 \begin_layout Description
1184 Action Moves the cursor one line in downward direction adding the current
1185 position to the selection.
1188 \begin_layout Description
1192 \begin_layout Subsection*
1196 \begin_layout Description
1197 Action Moves the cursor one line in upward direction adding the current
1198 position to the selection.
1201 \begin_layout Description
1205 \begin_layout Subsection*
1209 \begin_layout Description
1210 Action Moves the cursor one page in downward direction.
1213 \begin_layout Description
1217 \begin_layout Subsection*
1221 \begin_layout Description
1222 Action Moves the cursor one page in upward direction.
1225 \begin_layout Description
1229 \begin_layout Subsection*
1230 LFUN_SCREEN_DOWN_SELECT
1233 \begin_layout Description
1234 Action Moves the cursor one screen in downward direction adding the current
1235 position to the selection.
1238 \begin_layout Description
1239 Syntax screen-down-select
1242 \begin_layout Subsection*
1243 LFUN_SCREEN_UP_SELECT
1246 \begin_layout Description
1247 Action Moves the cursor one page in upward direction adding the current
1248 position to the selection.
1251 \begin_layout Description
1252 Syntax screen-up-select
1255 \begin_layout Subsection*
1259 \begin_layout Description
1260 Action Scroll the buffer view.
1263 \begin_layout Description
1264 Notion Only scrolls the screen up or down; does not move the cursor.
1267 \begin_layout Description
1268 Syntax scroll <TYPE> <QUANTITY>
1271 \begin_layout Description
1272 Params <TYPE>: line|page
1273 \begin_inset Newline newline
1276 <QUANTITY>: up|down|<number>
1279 \begin_layout Description
1280 Origin Abdel, Dec 27 2007
1283 \begin_layout Subsection*
1284 LFUN_SCREEN_RECENTER
1287 \begin_layout Description
1288 Action Recenters the screen on the current cursor position.
1291 \begin_layout Description
1292 Syntax screen-recenter
1295 \begin_layout Subsection*
1296 LFUN_SCREEN_SHOW_CURSOR
1299 \begin_layout Description
1300 Action Repositions the screen such that the cursor is visible.
1303 \begin_layout Description
1304 Syntax screen-show-cursor
1307 \begin_layout Description
1308 Origin vfr, 25 Mar 2009
1311 \begin_layout Subsection*
1315 \begin_layout Description
1316 Action Moves the cursor one position logically backwards.
1319 \begin_layout Description
1320 Notion This is not the action which should be bound to the arrow keys, because
1321 backwards may be left or right, depending on the language.
1322 The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions,
1323 which in turn may employ this one.
1326 \begin_layout Description
1327 Syntax char-backward
1330 \begin_layout Subsection*
1331 LFUN_CHAR_BACKWARD_SELECT
1334 \begin_layout Description
1335 Action Moves the cursor one position logically backwards, adding traversed
1336 position to the selection.
1339 \begin_layout Description
1340 Notion See also LFUN_CHAR_BACKWARD.
1343 \begin_layout Description
1344 Syntax char-backward-select
1347 \begin_layout Subsection*
1348 LFUN_CHAR_DELETE_BACKWARD
1351 \begin_layout Description
1352 Action Deletes one character in the backward direction (usually the "BackSpace"
1356 \begin_layout Description
1357 Syntax char-delete-backward
1360 \begin_layout Subsection*
1361 LFUN_CHAR_DELETE_FORWARD
1364 \begin_layout Description
1365 Action Deletes one character in the backward direction (usually the "Delete"
1369 \begin_layout Description
1370 Syntax char-delete-forward
1373 \begin_layout Subsection*
1377 \begin_layout Description
1378 Action Moves the cursor one position logically forward.
1381 \begin_layout Description
1382 Notion This is not the action which should be bound to the arrow keys, because
1383 forward may be left or right, depending on the language.
1384 The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions,
1385 which in turn may employ this one.
1388 \begin_layout Description
1392 \begin_layout Subsection*
1393 LFUN_CHAR_FORWARD_SELECT
1396 \begin_layout Description
1397 Action Moves the cursor one position logically forward, adding traversed
1398 position to the selection.
1401 \begin_layout Description
1402 Notion See also LFUN_CHAR_FORWARD.
1405 \begin_layout Description
1406 Syntax char-forward-select
1409 \begin_layout Subsection*
1413 \begin_layout Description
1414 Action Moves the cursor one position "to the left".
1417 \begin_layout Description
1418 Notion This is the action which should be taken when the "left" key is pressed.
1419 Generally, it moves the cursor one position to the left.
1420 However, in Bidi text this become slightly more complicated, and there
1421 are different modes of cursor movement.
1422 In "visual mode", this moves left, plain and simple.
1423 In "logical mode", movement is logically forward in RTL paragraphs, and
1424 logically backwards in LTR paragraphs.
1427 \begin_layout Description
1431 \begin_layout Subsection*
1432 LFUN_CHAR_LEFT_SELECT
1435 \begin_layout Description
1436 Action Moves the cursor one position "to the left", adding traversed position
1440 \begin_layout Description
1441 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1444 \begin_layout Description
1445 Syntax char-left-select
1448 \begin_layout Subsection*
1452 \begin_layout Description
1453 Action Moves the cursor one position "to the right".
1456 \begin_layout Description
1457 Notion This is the action which should be taken when the "right" key is
1459 Generally, it moves the cursor one position to the right.
1460 However, in Bidi text this become slightly more complicated, and there
1461 are different modes of cursor movement.
1462 In "visual mode", this moves right, plain and simple.
1463 In "logical mode", movement is logically forward in LTR paragraphs, and
1464 logically backwards in RTL paragraphs.
1467 \begin_layout Description
1471 \begin_layout Subsection*
1472 LFUN_CHAR_RIGHT_SELECT
1475 \begin_layout Description
1476 Action Moves the cursor one position "to the right", adding traversed position
1480 \begin_layout Description
1481 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1484 \begin_layout Description
1485 Syntax char-right-select
1488 \begin_layout Subsection*
1492 \begin_layout Description
1493 Action Moves the cursor to the logically previous beginning of a word.
1496 \begin_layout Description
1497 Notion This is not the action which should be bound to the arrow keys, because
1498 backwards may be left or right, depending on the language.
1499 The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
1500 which in turn may employ this one.
1503 \begin_layout Description
1504 Syntax word-backward
1507 \begin_layout Subsection*
1508 LFUN_WORD_BACKWARD_SELECT
1511 \begin_layout Description
1512 Action Moves the cursor to the logically previous beginning of a word, adding
1513 the logically traversed text to the selection.
1516 \begin_layout Description
1517 Notion See also LFUN_WORD_BACKWARD.
1520 \begin_layout Description
1521 Syntax word-backward-select
1524 \begin_layout Subsection*
1525 LFUN_WORD_DELETE_BACKWARD
1528 \begin_layout Description
1529 Action Deletes characters to the beginning of the word (usually the "C+BackSpace
1533 \begin_layout Description
1534 Syntax word-delete-backward
1537 \begin_layout Subsection*
1538 LFUN_WORD_DELETE_FORWARD
1541 \begin_layout Description
1542 Action Deletes characters to the end of the word (usually the "C+Delete"
1546 \begin_layout Description
1547 Syntax word-delete-forward
1550 \begin_layout Subsection*
1551 LFUN_WORD_FIND_FORWARD
1554 \begin_layout Description
1555 Action Search for a given string in forward direction.
1558 \begin_layout Description
1559 Notion Case sensitive, match words.
1560 If no argument given, last search repeated.
1563 \begin_layout Description
1564 Syntax word-find-forward [<STRING>]
1567 \begin_layout Description
1568 Origin Etienne, 16 Feb 1998
1571 \begin_layout Subsection*
1572 LFUN_WORD_FIND_BACKWARD
1575 \begin_layout Description
1576 Action Search for a given string in backward direction.
1579 \begin_layout Description
1580 Notion Case sensitive, match words.
1581 If no argument given, last search repeated.
1584 \begin_layout Description
1585 Syntax word-find-backward [<STRING>]
1588 \begin_layout Description
1589 Origin Etienne, 20 Feb 1998
1592 \begin_layout Subsection*
1596 \begin_layout Description
1597 Action Search for next occurrence of a string.
1600 \begin_layout Description
1601 Syntax word-find [<DATA>]
1604 \begin_layout Description
1605 Params <DATA>: data encoded from Find dialog (see lyx::find2string()).
1606 If no parameter is given, search with last find-dialog data is used for
1611 \begin_layout Description
1612 Origin Andre, Jan 7 2004
1615 \begin_layout Subsection*
1619 \begin_layout Description
1620 Action Replace a string in the document.
1623 \begin_layout Description
1624 Syntax word-replace [<DATA>]
1627 \begin_layout Description
1628 Params <DATA>: data is of the form "<replace>
1629 \begin_inset Newline newline
1633 \begin_inset Newline newline
1636 <casesensitive> <matchword> <all> <forward> <findnext>"
1639 \begin_layout Description
1640 Origin Andre, Jan 7 2004
1643 \begin_layout Subsection*
1647 \begin_layout Description
1648 Action Search for next occurrence of a pattern.
1651 \begin_layout Description
1652 Syntax word-findadv [<DATA>]
1655 \begin_layout Description
1656 Params <DATA>: data encoded from FindAdv dialog (see lyx::findadv2string()).
1657 If no parameter is given, search with last find-dialog data is used for
1662 \begin_layout Description
1663 Origin Tommaso, Nov 15 2007
1666 \begin_layout Subsection*
1670 \begin_layout Description
1671 Action Moves the cursor to the logically next beginning of a word.
1674 \begin_layout Description
1675 Notion This is not the action which should be bound to the arrow keys, because
1676 forward may be left or right, depending on the language.
1677 The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
1678 which in turn may employ this one.
1681 \begin_layout Description
1685 \begin_layout Subsection*
1686 LFUN_WORD_FORWARD_SELECT
1689 \begin_layout Description
1690 Action Moves the cursor to the logically next beginning of a word, adding
1691 the logically traversed text to the selection.
1694 \begin_layout Description
1695 Notion See also LFUN_WORD_FORWARD.
1698 \begin_layout Description
1699 Syntax word-forward-select
1702 \begin_layout Subsection*
1706 \begin_layout Description
1707 Action Moves the cursor to the next beginning of a word "on the left".
1710 \begin_layout Description
1711 Notion This is the action which should be taken when the (e.g., ctrl-) "left"
1713 Generally, it moves the cursor to the next beginning of a word on the left.
1714 However, in Bidi text this become slightly more complicated, and there
1715 are different modes of cursor movement.
1716 In "visual mode", this moves left, plain and simple.
1717 In "logical mode", movement is logically forward in RTL paragraphs, and
1718 logically backwards in LTR paragraphs.
1721 \begin_layout Description
1725 \begin_layout Description
1726 Origin dov, 28 Oct 2007
1729 \begin_layout Subsection*
1730 LFUN_WORD_LEFT_SELECT
1733 \begin_layout Description
1734 Action Moves the cursor to the next beginning of a word "on the left", adding
1735 *logically* traversed text to the selection.
1738 \begin_layout Description
1739 Notion See also LFUN_WORD_LEFT for exact details of the movement.
1742 \begin_layout Description
1743 Syntax word-left-select
1746 \begin_layout Description
1747 Origin dov, 28 Oct 2007
1750 \begin_layout Subsection*
1754 \begin_layout Description
1755 Action Moves the cursor to the next beginning of a word "on the right".
1758 \begin_layout Description
1759 Notion This is the action which should be taken when the (e.g., ctrl-) "right"
1761 Generally, it moves the cursor to the next beginning of a word on the right.
1762 However, in Bidi text this become slightly more complicated, and there
1763 are different modes of cursor movement.
1764 In "visual mode", this moves right, plain and simple.
1765 In "logical mode", movement is logically forward in LTR paragraphs, and
1766 logically backwards in RTL paragraphs.
1769 \begin_layout Description
1773 \begin_layout Description
1774 Origin dov, 28 Oct 2007
1777 \begin_layout Subsection*
1778 LFUN_WORD_RIGHT_SELECT
1781 \begin_layout Description
1782 Action Moves the cursor to the next beginning of a word "on the right",
1783 adding *logically* traversed text to the selection.
1786 \begin_layout Description
1787 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
1790 \begin_layout Description
1791 Syntax word-right-select
1794 \begin_layout Description
1795 Origin dov, 28 Oct 2007
1798 \begin_layout Subsection*
1802 \begin_layout Description
1803 Action Puts the word where the cursor stands into the selection.
1806 \begin_layout Description
1810 \begin_layout Description
1811 Origin Andre, 11 Sep 2002
1814 \begin_layout Subsection*
1815 LFUN_WORD_CAPITALIZE
1818 \begin_layout Description
1819 Action Capitalizes the words in the selection (i.e.
1820 the first letters) or the letter on the cursor position.
1823 \begin_layout Description
1824 Syntax word-capitalize
1827 \begin_layout Subsection*
1831 \begin_layout Description
1832 Action Change the words in the selection or from the cursor position to
1833 the end of word to the upper case.
1836 \begin_layout Description
1840 \begin_layout Subsection*
1844 \begin_layout Description
1845 Action Change the words in the selection or from the cursor position to
1846 the end of word to the lower case.
1849 \begin_layout Description
1853 \begin_layout Subsection*
1857 \begin_layout Description
1858 Action Add the word under the cursor to the respective spell checker dictionary.
1861 \begin_layout Description
1862 Syntax spelling-add [<STRING>] [<LANG>]
1865 \begin_layout Description
1866 Params <WORD>: word to add <LANG>: language name (see file languages)
1869 \begin_layout Description
1870 Origin JSpitzm, 18 Jan 2010
1873 \begin_layout Subsection*
1874 LFUN_SPELLING_IGNORE
1877 \begin_layout Description
1878 Action Let the spell checker ignore the word under the cursor in the current
1879 session for the given language.
1882 \begin_layout Description
1883 Syntax spelling-ignore [<WORD>] [<LANG>]
1886 \begin_layout Description
1887 Params <WORD>: word to ignore <LANG>: language name (see file languages)
1890 \begin_layout Description
1891 Origin JSpitzm, 18 Jan 2010
1894 \begin_layout Subsection*
1895 LFUN_SPELLING_REMOVE
1898 \begin_layout Description
1899 Action Remove the word under the cursor from the respective spell checker
1903 \begin_layout Description
1904 Syntax spelling-remove [<STRING>] [<LANG>]
1907 \begin_layout Description
1908 Params <WORD>: word to remove <LANG>: language name (see file languages)
1911 \begin_layout Description
1912 Origin SWitt, 28 July 2010
1915 \begin_layout Subsection*
1916 LFUN_SPELLING_CONTINUOUSLY
1919 \begin_layout Description
1920 Action Toggle continuous spell checking.
1923 \begin_layout Description
1924 Syntax spelling-continuously
1927 \begin_layout Description
1928 Origin vfr, 24 March 2013
1931 \begin_layout Subsection*
1932 LFUN_THESAURUS_ENTRY
1935 \begin_layout Description
1936 Action Look up thesaurus entries with respect to the word under the cursor.
1939 \begin_layout Description
1940 Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
1943 \begin_layout Description
1944 Params <STRING>: word to look up <LANG>: language (see file languages)
1947 \begin_layout Description
1948 Origin Levon, 20 Jul 2001
1951 \begin_layout Subsection*
1955 \begin_layout Description
1956 Action Move the cursor to the beginning of the document.
1959 \begin_layout Description
1963 \begin_layout Subsection*
1964 LFUN_BUFFER_BEGIN_SELECT
1967 \begin_layout Description
1968 Action Move the cursor to the beginning of the document adding the traversed
1969 text to the selection.
1972 \begin_layout Description
1973 Syntax buffer-begin-select
1976 \begin_layout Subsection*
1980 \begin_layout Description
1981 Action Move the cursor to the end of the document.
1984 \begin_layout Description
1988 \begin_layout Subsection*
1989 LFUN_BUFFER_END_SELECT
1992 \begin_layout Description
1993 Action Move the cursor to the end of the document adding the traversed text
1997 \begin_layout Description
1998 Syntax buffer-end-select
2001 \begin_layout Subsection*
2005 \begin_layout Description
2006 Action Move the cursor to the beginning of the current inset if it is not
2007 already there, or at the beginning of the enclosing inset otherwise
2010 \begin_layout Description
2014 \begin_layout Description
2015 Origin lasgouttes, 16 Mar 2009
2018 \begin_layout Subsection*
2019 LFUN_INSET_BEGIN_SELECT
2022 \begin_layout Description
2023 Action Move the cursor to the beginning of the current inset if it is not
2024 already there, or at the beginning of the enclosing inset otherwise (adding
2025 the traversed text to the selection).
2028 \begin_layout Description
2029 Syntax inset-begin-select
2032 \begin_layout Description
2033 Origin lasgouttes, 16 Mar 2009
2036 \begin_layout Subsection*
2040 \begin_layout Description
2041 Action Move the cursor to the end of the current inset if it is not already
2042 there, or at the end of the enclosing inset otherwise
2045 \begin_layout Description
2049 \begin_layout Description
2050 Origin lasgouttes, 16 Mar 2009
2053 \begin_layout Subsection*
2054 LFUN_INSET_END_SELECT
2057 \begin_layout Description
2058 Action Move the cursor to the end of the current inset if it is not already
2059 there, or at the end of the enclosing inset otherwise (adding the traversed
2060 text to the selection).
2063 \begin_layout Description
2064 Syntax inset-end-select
2067 \begin_layout Description
2068 Origin lasgouttes, 16 Mar 2009
2071 \begin_layout Subsection*
2072 LFUN_INSET_SELECT_ALL
2075 \begin_layout Description
2076 Action Selects all contents of an inset.
2079 \begin_layout Description
2080 Syntax inset-select-all
2083 \begin_layout Description
2084 Origin vfr, 22 Aug 2009
2087 \begin_layout Subsection*
2091 \begin_layout Description
2092 Action Selects the whole section.
2095 \begin_layout Description
2096 Notion The cursor should be in a section heading before calling this lfun.
2099 \begin_layout Description
2100 Syntax section-select
2103 \begin_layout Description
2104 Origin vfr, 05 May 2009
2107 \begin_layout Subsection*
2111 \begin_layout Description
2112 Action Move the cursor to the beginning of the (screen) line.
2115 \begin_layout Description
2119 \begin_layout Subsection*
2120 LFUN_LINE_BEGIN_SELECT
2123 \begin_layout Description
2124 Action Move the cursor to the beginning of the (screen) line adding the
2125 traversed text to the selection.
2128 \begin_layout Description
2129 Syntax line-begin-select
2132 \begin_layout Subsection*
2136 \begin_layout Description
2137 Action Move the cursor to the end of the (screen) line.
2140 \begin_layout Description
2144 \begin_layout Subsection*
2145 LFUN_LINE_END_SELECT
2148 \begin_layout Description
2149 Action Move the cursor to the end of the (screen) line adding the traversed
2150 text to the selection.
2153 \begin_layout Description
2154 Syntax line-end-select
2157 \begin_layout Subsection*
2161 \begin_layout Description
2162 Action Deletes the letters to the end of the (screen) line or deletes the
2166 \begin_layout Description
2167 Syntax line-delete-forward
2170 \begin_layout Subsection*
2174 \begin_layout Description
2175 Action Copies the current selection to the clipboard.
2178 \begin_layout Description
2182 \begin_layout Subsection*
2186 \begin_layout Description
2187 Action Cuts to the clipboard.
2190 \begin_layout Description
2194 \begin_layout Subsection*
2198 \begin_layout Description
2199 Action Pastes material (text or picture) from the active clipboard.
2202 \begin_layout Description
2203 Syntax paste [<TYPE>|<NUM>]
2206 \begin_layout Description
2207 Params <TYPE>: emf|pdf|png|jpeg|linkback|wmf|latex|html
2208 \begin_inset Newline newline
2211 <NUM>: number of the selection in the internal clipboard stack to be pasted.
2214 \begin_layout Subsection*
2215 LFUN_CLIPBOARD_PASTE
2218 \begin_layout Description
2219 Action Pastes text from the active clipboard.
2222 \begin_layout Description
2223 Syntax clipboard-paste [<ARG>]
2226 \begin_layout Description
2227 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
2231 \begin_layout Description
2232 Origin Georg, 10 Jul 2006
2235 \begin_layout Subsection*
2236 LFUN_PRIMARY_SELECTION_PASTE
2239 \begin_layout Description
2240 Action Pastes the currently selected text.
2243 \begin_layout Description
2244 Notion Primary selection mechanism is linux-only thing.
2247 \begin_layout Description
2248 Syntax primary-selection-paste [<ARG>]
2251 \begin_layout Description
2252 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
2256 \begin_layout Subsection*
2257 LFUN_SELECTION_PASTE
2260 \begin_layout Description
2261 Action Pastes the internal selection text in permanent selection.
2264 \begin_layout Description
2265 Notion Created in order to have middle mouse button pasting correct (bound
2266 to command-alternatives selection-paste ; primary-selection-paste paragraph).
2269 \begin_layout Description
2270 Syntax selection-paste
2273 \begin_layout Description
2274 Origin lasgouttes, 14 Jan 2009
2277 \begin_layout Subsection*
2278 LFUN_CLIPBOARD_PASTE_SIMPLE
2281 \begin_layout Description
2282 Action Pastes simple unformatted text from the active clipboard.
2285 \begin_layout Description
2286 Syntax clipboard-paste-simple [<ARG>]
2289 \begin_layout Description
2290 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
2294 \begin_layout Subsection*
2298 \begin_layout Description
2299 Action Undoes the last edit.
2302 \begin_layout Description
2306 \begin_layout Subsection*
2310 \begin_layout Description
2311 Action Redoes the last thing undone.
2314 \begin_layout Description
2318 \begin_layout Subsection*
2322 \begin_layout Description
2323 Action Repeat the given command.
2326 \begin_layout Description
2327 Syntax repeat <COUNT> <LFUN-COMMAND>
2330 \begin_layout Description
2331 Origin Andre, 27 Oct 2003
2334 \begin_layout Subsection*
2335 LFUN_CHARS_TRANSPOSE
2338 \begin_layout Description
2339 Action Transposes the character at the cursor with the one before it.
2342 \begin_layout Description
2343 Syntax chars-transpose
2346 \begin_layout Description
2347 Origin Lgb, 25 Apr 2001
2350 \begin_layout Subsection*
2351 LFUN_DEPTH_DECREMENT
2354 \begin_layout Description
2355 Action Decrease the nesting depth of the (selected) paragraph(s) inside
2359 \begin_layout Description
2360 Syntax depth-decrement
2363 \begin_layout Subsection*
2364 LFUN_DEPTH_INCREMENT
2367 \begin_layout Description
2368 Action Increase the nesting depth of the (selected) paragraph(s) inside
2372 \begin_layout Description
2373 Syntax depth-increment
2376 \begin_layout Subsection*
2380 \begin_layout Description
2381 Action Toggles the bold font (selection-wise) using mathbf in math.
2384 \begin_layout Description
2388 \begin_layout Subsection*
2389 LFUN_FONT_BOLDSYMBOL
2392 \begin_layout Description
2393 Action Toggles the bold font (selection-wise) using boldsymbol in math.
2396 \begin_layout Description
2397 Syntax font-boldsymbol
2400 \begin_layout Subsection*
2401 LFUN_FONT_TYPEWRITER
2404 \begin_layout Description
2405 Action Toggles the typewriter family font (selection-wise).
2408 \begin_layout Description
2409 Syntax font-typewriter
2412 \begin_layout Subsection*
2416 \begin_layout Description
2417 Action Toggles underline in the font (selection-wise).
2420 \begin_layout Description
2421 Syntax font-underline
2424 \begin_layout Subsection*
2428 \begin_layout Description
2429 Action Toggles double underline in the font (selection-wise).
2432 \begin_layout Description
2433 Syntax font-underunderline
2436 \begin_layout Description
2437 Origin sanda, 5 May 2009
2440 \begin_layout Subsection*
2444 \begin_layout Description
2445 Action Toggles wavy underline in the font (selection-wise).
2448 \begin_layout Description
2449 Syntax font-underwave
2452 \begin_layout Description
2453 Origin sanda, 5 May 2009
2456 \begin_layout Subsection*
2460 \begin_layout Description
2461 Action Toggles strikeout (strike-through) in the font (selection-wise).
2464 \begin_layout Description
2465 Syntax font-strikeout
2468 \begin_layout Description
2469 Origin sanda, 3 May 2009
2472 \begin_layout Subsection*
2476 \begin_layout Description
2477 Action Toggles the emphasis font style (selection-wise).
2480 \begin_layout Description
2484 \begin_layout Subsection*
2488 \begin_layout Description
2489 Action Toggles Noun text style font (selection-wise).
2492 \begin_layout Description
2496 \begin_layout Subsection*
2500 \begin_layout Description
2501 Action Toggles Roman family font (selection-wise).
2504 \begin_layout Description
2508 \begin_layout Subsection*
2512 \begin_layout Description
2513 Action Toggles Sans Serif family font (selection-wise).
2516 \begin_layout Description
2520 \begin_layout Subsection*
2524 \begin_layout Description
2525 Action Toggles Fraktur family font (math-mode, selection-wise).
2528 \begin_layout Description
2532 \begin_layout Description
2533 Origin vermeer, 10 Jan 2002
2536 \begin_layout Subsection*
2540 \begin_layout Description
2541 Action Toggles Italics font shape (math-mode, selection-wise).
2544 \begin_layout Description
2548 \begin_layout Description
2549 Origin vermeer, 10 Jan 2002
2552 \begin_layout Subsection*
2556 \begin_layout Description
2557 Action Reverts the settings of the font to the default values (selection-wise).
2560 \begin_layout Description
2564 \begin_layout Subsection*
2568 \begin_layout Description
2569 Action Sets font size according to lyx format string.
2572 \begin_layout Description
2573 Syntax font-size <SIZE>
2576 \begin_layout Description
2577 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
2578 \begin_inset Newline newline
2581 largest|huge|giant|increase|decrease|default
2584 \begin_layout Subsection*
2585 LFUN_TEXTSTYLE_APPLY
2588 \begin_layout Description
2589 Action Toggle user-defined (=last-time used) text style.
2592 \begin_layout Description
2593 Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically
2594 triggered when using Text Style dialog.
2597 \begin_layout Description
2598 Syntax textstyle-apply
2601 \begin_layout Description
2602 Origin leeming, 12 Mar 2003
2605 \begin_layout Subsection*
2606 LFUN_TEXTSTYLE_UPDATE
2609 \begin_layout Description
2610 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APP
2614 \begin_layout Description
2615 Syntax textstyle-update <FONT_INFO>
2618 \begin_layout Description
2619 Params <FONT_INFO>: specifies font atributes, e.g.
2620 family, series, shape, size, emph, noun, underbar, number, color, language,
2622 \begin_inset Newline newline
2625 Use lyx -dbg action for exact syntax of text-style dialog parameters.
2628 \begin_layout Description
2629 Origin leeming, 12 Mar 2003
2632 \begin_layout Subsection*
2633 LFUN_SCREEN_FONT_UPDATE
2636 \begin_layout Description
2637 Action Update fonts and its metrics.
2640 \begin_layout Description
2641 Notion Automatically called after zoom, dpi, font names, or norm change.
2644 \begin_layout Description
2645 Syntax screen-font-update
2648 \begin_layout Description
2649 Origin ARRae, 13 Aug 2000
2652 \begin_layout Subsection*
2656 \begin_layout Description
2657 Action Returns the info about the current font.
2660 \begin_layout Description
2664 \begin_layout Subsection*
2665 LFUN_CITATION_INSERT
2668 \begin_layout Description
2669 Action Inserts citation from loaded citation database.
2672 \begin_layout Description
2673 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
2676 \begin_layout Description
2677 Params <KEY>: Citation (shortcut listed in available citations).
2678 \begin_inset Newline newline
2681 <TEXT_BEFORE>: text which should appear before citation.
2684 \begin_layout Description
2685 Origin AAS, 97-02-23
2688 \begin_layout Subsection*
2689 LFUN_BIBTEX_DATABASE_ADD
2692 \begin_layout Description
2693 Action Adds database, which will be used for bibtex citations.
2696 \begin_layout Description
2697 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX
2698 bibliography) found from the cursor position.
2701 \begin_layout Description
2702 Syntax bibtex-database-add <DATABASE-NAME>
2705 \begin_layout Description
2706 Origin Ale, 30 May 1997
2709 \begin_layout Subsection*
2710 LFUN_BIBTEX_DATABASE_DEL
2713 \begin_layout Description
2714 Action Adds database, which will be used for bibtex citations.
2717 \begin_layout Description
2718 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTe
2719 X bibliography) found from the cursor position.
2722 \begin_layout Description
2723 Syntax bibtex-database-del <DATABASE-NAME>
2726 \begin_layout Description
2727 Origin Ale, 30 May 1997
2730 \begin_layout Subsection*
2734 \begin_layout Description
2735 Action Sets the layout (that is, environment) for the current paragraph.
2738 \begin_layout Description
2739 Syntax layout <LAYOUT>
2742 \begin_layout Description
2743 Params <LAYOUT>: the layout to use
2746 \begin_layout Subsection*
2747 LFUN_LAYOUT_PARAGRAPH
2750 \begin_layout Description
2751 Action Launches the paragraph settings dialog.
2754 \begin_layout Description
2755 Syntax layout-paragraph
2758 \begin_layout Subsection*
2762 \begin_layout Description
2763 Action Launches the tabular settings dialog.
2766 \begin_layout Description
2767 Syntax layout-tabular
2770 \begin_layout Description
2771 Origin Jug, 31 Jul 2000
2774 \begin_layout Subsection*
2775 LFUN_DROP_LAYOUTS_CHOICE
2778 \begin_layout Description
2779 Action Displays list of layout choices.
2782 \begin_layout Description
2783 Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox
2784 allowing for choice of layout.
2787 \begin_layout Description
2788 Syntax drop-layouts-choice
2791 \begin_layout Subsection*
2792 LFUN_LAYOUT_MODULES_CLEAR
2795 \begin_layout Description
2796 Action Clears the module list.
2799 \begin_layout Description
2800 Notion Clears the list of included modules for the current buffer.
2803 \begin_layout Description
2804 Syntax layout-modules-clear
2807 \begin_layout Description
2808 Origin rgh, 25 August 2007
2811 \begin_layout Subsection*
2812 LFUN_LAYOUT_MODULE_ADD
2815 \begin_layout Description
2816 Action Adds a module.
2819 \begin_layout Description
2820 Notion Adds a module to the list of included modules for the current buffer.
2823 \begin_layout Description
2824 Syntax layout-module-add <MODULE>
2827 \begin_layout Description
2828 Params <MODULE>: the module to be added
2831 \begin_layout Description
2832 Origin rgh, 25 August 2007
2835 \begin_layout Subsection*
2839 \begin_layout Description
2840 Action Reloads layout information.
2843 \begin_layout Description
2844 Notion Reloads all layout information for the current buffer from disk,
2845 thus recognizing any changes that have been made to layout files on the
2847 This is intended to be used only by layout developers and should not be
2848 used when one is trying to do actual work.
2851 \begin_layout Description
2852 Syntax layout-reload
2855 \begin_layout Description
2856 Origin rgh, 3 September 2007
2859 \begin_layout Subsection*
2860 LFUN_TEXTCLASS_APPLY
2863 \begin_layout Description
2864 Action Sets the text class for the current buffer.
2867 \begin_layout Description
2868 Syntax textclass-apply <TEXTCLASS>
2871 \begin_layout Description
2872 Params <TEXTCLASS>: the textclass to set.
2873 Note that this must be the filename, minus the ".layout" extension.
2876 \begin_layout Subsection*
2880 \begin_layout Description
2881 Action Loads information for a textclass from disk.
2884 \begin_layout Description
2885 Syntax textclass-load <TEXTCLASS>
2888 \begin_layout Description
2889 Params <TEXTCLASS>: the textclass to load.
2890 Note that this must be the filename, minus the ".layout" extension.
2893 \begin_layout Subsection*
2897 \begin_layout Description
2898 Action Disable selecting of text-region.
2901 \begin_layout Description
2905 \begin_layout Subsection*
2909 \begin_layout Description
2910 Action Enable selecting of text-region.
2913 \begin_layout Description
2914 Notion After enabling you can simply move arrow keys to get selected region.
2917 \begin_layout Description
2921 \begin_layout Subsection*
2925 \begin_layout Description
2926 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
2929 \begin_layout Description
2933 \begin_layout Description
2934 Origin Andre, May 5 2006
2937 \begin_layout Subsection*
2941 \begin_layout Description
2942 Action Inserts math delimiters (e.g.
2943 parentheses, brackets) enclosing expression.
2946 \begin_layout Description
2947 Syntax math-delim [<LEFT>] [<RIGHT>]
2950 \begin_layout Description
2951 Params <LEFT/RIGHT>: Delimiters to be used.
2952 Each delimiter can be specified by either a LaTeX name or a valid character.
2953 ( is the default letter.
2956 \begin_layout Description
2957 Sample math-delim { rangle
2960 \begin_layout Description
2961 Origin Alejandro, 18 Jun 1996
2964 \begin_layout Subsection*
2968 \begin_layout Description
2969 Action Inserts math fixed size delimiters (e.g.
2970 parentheses, brackets) enclosing expression.
2973 \begin_layout Description
2974 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
2977 \begin_layout Description
2978 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
2979 \begin_inset Newline newline
2982 <L/RDELIM>: TeX code for delimiter.
2983 See Delimiter dialog for delimiters to be used.
2986 \begin_layout Description
2987 Sample math-bigdelim "Bigl" "
2994 \begin_layout Description
2995 Origin Enrico & Georg, 7 May 2006
2998 \begin_layout Subsection*
3002 \begin_layout Description
3003 Action Creates a new displayed equation in text mode.
3004 Toggles inlined/display formula in math mode.
3007 \begin_layout Description
3008 Syntax math-display [<ARG>]
3011 \begin_layout Description
3012 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating
3013 new equation from the text mode.
3016 \begin_layout Description
3017 Origin Alejandro, 18 Jun 1996
3020 \begin_layout Subsection*
3024 \begin_layout Description
3025 Action Inserts math objects and symbols.
3028 \begin_layout Description
3029 Notion When <ARG> is a _single_ math inset with more than one cell (such
3032 frac{x}{y}"), the content of cell(0) is replaced by the current selection
3033 (only works if the selection is in mathed).
3034 As an example, if "abc" is selected in mathed, "math-insert
3036 frac{x}{y}" replaces "abc" with "
3038 frac{abc}{y}", and "math-insert x_y^z" replaces "abc" with "abc_y^z".
3039 If nothing is selected (or the selection is not in mathed), math-insert
3043 \begin_layout Description
3044 Syntax math-insert <ARG>
3047 \begin_layout Description
3048 Params <ARG>: Symbol or LaTeX code to be inserted.
3051 \begin_layout Subsection*
3055 \begin_layout Description
3056 Action Enters subscript expression in math expression.
3059 \begin_layout Description
3060 Syntax math-subscript
3063 \begin_layout Description
3064 Origin vermeer, 12 Dec 2001
3067 \begin_layout Subsection*
3068 LFUN_MATH_SUPERSCRIPT
3071 \begin_layout Description
3072 Action Enters superscript expression in math expression.
3075 \begin_layout Description
3076 Syntax math-superscript
3079 \begin_layout Description
3080 Origin vermeer, 12 Dec 2001
3083 \begin_layout Subsection*
3087 \begin_layout Description
3088 Action Toggles the position of the limits from above/below to the right
3089 side an vice versa in integral symbol, a limit, a summation, etc.
3092 \begin_layout Description
3093 Notion Put the cursor before the symbol with the limits and then invoke
3097 \begin_layout Description
3098 Syntax math-limits [<STATE>]
3101 \begin_layout Description
3102 Params <STATE>: limits|nolimits
3105 \begin_layout Subsection*
3109 \begin_layout Description
3110 Action Inserts a math macro definition at the cursor position in the text.
3113 \begin_layout Description
3114 Syntax math-macro <NAME> [<NARGS>] [def]
3117 \begin_layout Description
3118 Params <NAME>: The name of the macro, e.g.
3120 \begin_inset Newline newline
3123 <NARGS>: The number of parameters of the macro.
3125 "def": Has no effect anymore, just for compatibility with former LyX versions.
3128 \begin_layout Description
3129 Origin ale, 10 May 1997; sts, 21 Dec 2007
3132 \begin_layout Subsection*
3136 \begin_layout Description
3137 Action Mutates the type of math inset to the newly selected one.
3140 \begin_layout Description
3141 Syntax math-mutate <TYPE>
3144 \begin_layout Description
3145 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
3146 multline|gather|flalign
3149 \begin_layout Description
3150 Origin Andre, 23 May 2001
3153 \begin_layout Subsection*
3157 \begin_layout Description
3158 Action Inserts space into math expression.
3161 \begin_layout Description
3162 Notion Use spacebar after entering this space to change type of space.
3165 \begin_layout Description
3166 Syntax math-space [<TYPE>] [<LEN>]
3169 \begin_layout Description
3170 Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
3171 \begin_inset Newline newline
3174 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
3175 \begin_inset Newline newline
3178 custom space: hspace
3179 \begin_inset Newline newline
3182 "," used by default.
3183 \begin_inset Newline newline
3186 Note that ! is equivalent to negthinspace, , = thinspace, : = medspace,
3188 \begin_inset Newline newline
3191 <LEN>: length for custom spaces (hspace)
3194 \begin_layout Description
3195 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
3198 \begin_layout Subsection*
3202 \begin_layout Description
3203 Action Inserts a matrix.
3206 \begin_layout Description
3207 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
3210 \begin_layout Description
3211 Params <ALIGN>: Alignment is a word composed of the vertical alignment (b,
3213 1 char) and the horizontal alignments (l, c or r) (i.e.
3217 \begin_layout Description
3218 Sample math-matrix 3 3 bccc
3221 \begin_layout Subsection*
3222 LFUN_MATH_AMS_MATRIX
3225 \begin_layout Description
3226 Action Inserts a matrix.
3229 \begin_layout Description
3230 Syntax math-matrix <COLS> <ROWS> [<DECORATION>]
3233 \begin_layout Description
3234 Params <DECORATION>: Decoration determines the LaTeX name of the matrix
3235 that should be created.
3238 \begin_layout Description
3239 Sample math-ams-matrix 3 3 bmatrix
3242 \begin_layout Subsection*
3246 \begin_layout Description
3247 Action In text mode enters math mode (i.e.
3248 puts math insets on the current cursor position), in math mode enters text
3249 mode inside math expression.
3252 \begin_layout Description
3253 Notion If there is some selected text, it puts the text inside created math
3257 \begin_layout Description
3258 Syntax math-mode [on|<ARG>]
3261 \begin_layout Description
3262 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT
3264 \begin_inset Newline newline
3267 "on": allow only entering of math mode from text mode.
3270 \begin_layout Description
3271 Origin Alejandro, 4 Jun 1996
3274 \begin_layout Subsection*
3278 \begin_layout Description
3279 Action Enters regexp mode (i.e., puts regexp insets on the current cursor
3281 Used by the advanced search dialog.
3284 \begin_layout Description
3285 Notion If there is any selected text, then it is moved inside the created
3289 \begin_layout Description
3290 Syntax regexp-mode [<ARG>]
3293 \begin_layout Description
3294 Params <ARG>: eventual argument (regular expression).
3297 \begin_layout Description
3298 Origin Tommaso, 4 Oct 2008
3301 \begin_layout Subsection*
3302 LFUN_MATH_NUMBER_LINE_TOGGLE
3305 \begin_layout Description
3306 Action Toggles numbering of the current formula line.
3309 \begin_layout Description
3310 Notion Must be in display formula mode.
3313 \begin_layout Description
3314 Syntax math-number-line-toggle
3317 \begin_layout Description
3318 Origin Alejandro, 18 Jun 1996
3321 \begin_layout Subsection*
3322 LFUN_MATH_NUMBER_TOGGLE
3325 \begin_layout Description
3326 Action Toggles numbering/labeling of the current formula.
3329 \begin_layout Description
3330 Notion Must be in display formula mode.
3333 \begin_layout Description
3334 Syntax math-number-toggle
3337 \begin_layout Description
3338 Origin Alejandro, 4 Jun 1996
3341 \begin_layout Subsection*
3345 \begin_layout Description
3346 Action Calls external program and passes the current expression/equation
3347 as an argument for the calculation in the format appropriate to the given
3351 \begin_layout Description
3352 Notion Selection can be used to determine the input for the external program.
3355 \begin_layout Description
3356 Syntax math-extern <LANG> [<COMMAND>]
3359 \begin_layout Description
3360 Params <LANG>: octave|maxima|maple|mathematica|script
3361 \begin_inset Newline newline
3364 where "script" stands for the external script (normalized expression will
3368 \begin_layout Description
3369 Sample math-extern maple simplify
3372 \begin_layout Description
3373 Origin Andre, 24 Apr 2001
3376 \begin_layout Subsection*
3380 \begin_layout Description
3381 Action Changes arbitrarily the size used by math fonts inside a context.
3384 \begin_layout Description
3385 Notion Provides an interface to the LaTeX math mode font size commands.
3388 \begin_layout Description
3389 Syntax math-size <STYLE>
3392 \begin_layout Description
3404 \begin_layout Description
3405 Origin Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
3408 \begin_layout Subsection*
3409 LFUN_MATH_FONT_STYLE
3412 \begin_layout Description
3413 Action Changes the text style used in math.
3416 \begin_layout Description
3417 Syntax math-font-style <STYLE>
3420 \begin_layout Description
3421 Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal
3422 \begin_inset Newline newline
3425 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
3428 \begin_layout Description
3429 Origin vfr, 9 jan 2009
3432 \begin_layout Subsection*
3433 LFUN_MATH_MACRO_UNFOLD
3436 \begin_layout Description
3437 Action Unfold a Math Macro.
3440 \begin_layout Description
3441 Notion Unfold the Math Macro the cursor is in, i.e.
3447 \begin_layout Description
3448 Syntax math-macro-unfold
3451 \begin_layout Description
3452 Origin sts, 06 January 2008
3455 \begin_layout Subsection*
3456 LFUN_MATH_MACRO_FOLD
3459 \begin_layout Description
3460 Action Fold a Math Macro.
3463 \begin_layout Description
3464 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e.
3470 \begin_layout Description
3471 Syntax math-macro-fold
3474 \begin_layout Description
3475 Origin sts, 06 January 2008
3478 \begin_layout Subsection*
3479 LFUN_MATH_MACRO_ADD_PARAM
3482 \begin_layout Description
3483 Action Add a parameter.
3486 \begin_layout Description
3487 Notion Add a parameter to a Math Macro.
3490 \begin_layout Description
3491 Syntax math-macro-add-param <NUM>
3494 \begin_layout Description
3495 Params <NUM>: The number of the parameter behind which the new one will
3496 be added (1 for the first, i.e.
3497 use 0 for add a parameter at the left), defaults to the last one.
3500 \begin_layout Description
3501 Origin sts, 06 January 2008
3504 \begin_layout Subsection*
3505 LFUN_MATH_MACRO_REMOVE_PARAM
3508 \begin_layout Description
3509 Action Remove the last parameter.
3512 \begin_layout Description
3513 Notion Remove the last parameter of a Math Macro and remove its value in
3514 all instances of the macro in the buffer.
3517 \begin_layout Description
3518 Syntax math-macro-remove-param <NUM>
3521 \begin_layout Description
3522 Params <NUM>: The number of the parameter to be deleted (1 for the first),
3523 defaults to the last one.
3526 \begin_layout Description
3527 Origin sts, 06 January 2008
3530 \begin_layout Subsection*
3531 LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
3534 \begin_layout Description
3535 Action Append a greedy parameter.
3538 \begin_layout Description
3539 Notion Append a greedy parameter to a Math Macro which eats the following
3540 mathed cell in every instance of the macro in the buffer.
3543 \begin_layout Description
3544 Syntax math-macro-append-greedy-param
3547 \begin_layout Description
3548 Origin sts, 06 January 2008
3551 \begin_layout Subsection*
3552 LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
3555 \begin_layout Description
3556 Action Remove a greedy parameter.
3559 \begin_layout Description
3560 Notion Remove a greedy parameter of a Math Macro and spit out the values
3561 of it in every instance of the macro in the buffer.
3562 If it is an optional parameter the [valud] format is used.
3565 \begin_layout Description
3566 Syntax math-macro-remove-greedy-param
3569 \begin_layout Description
3570 Origin sts, 06 January 2008
3573 \begin_layout Subsection*
3574 LFUN_MATH_MACRO_MAKE_OPTIONAL
3577 \begin_layout Description
3578 Action Make a parameter optional.
3581 \begin_layout Description
3582 Notion Turn the first non-optional parameter of a Math Macro into an optional
3583 parameter with a default value.
3586 \begin_layout Description
3587 Syntax math-macro-make-optional
3590 \begin_layout Description
3591 Origin sts, 06 January 2008
3594 \begin_layout Subsection*
3595 LFUN_MATH_MACRO_MAKE_NONOPTIONAL
3598 \begin_layout Description
3599 Action Make a parameter non-optional.
3602 \begin_layout Description
3603 Notion Turn the last optional parameter of a Math Macro into a non-optional
3605 The default value is remembered to be reused later if the user changes
3609 \begin_layout Description
3610 Syntax math-macro-make-nonoptional
3613 \begin_layout Description
3614 Origin sts, 06 January 2008
3617 \begin_layout Subsection*
3618 LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
3621 \begin_layout Description
3622 Action Add an optional parameter.
3625 \begin_layout Description
3626 Notion Insert an optional parameter just behind the already existing optional
3630 \begin_layout Description
3631 Syntax math-macro-add-optional-param
3634 \begin_layout Description
3635 Origin sts, 06 January 2008
3638 \begin_layout Subsection*
3639 LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
3642 \begin_layout Description
3643 Action Remove the last optional parameter.
3646 \begin_layout Description
3647 Notion Remove the last optional parameter of a Math Macro and remove it
3648 in all the instances of the macro in the buffer.
3651 \begin_layout Description
3652 Syntax math-macro-remove-optional-param
3655 \begin_layout Description
3656 Origin sts, 06 January 2008
3659 \begin_layout Subsection*
3660 LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
3663 \begin_layout Description
3664 Action Add a greedy optional parameter.
3667 \begin_layout Description
3668 Notion Add a greedy optional parameter which eats the value from the following
3669 cells in mathed which are in the [value] format.
3672 \begin_layout Description
3673 Syntax math-macro-add-greedy-optional-param
3676 \begin_layout Description
3677 Origin sts, 06 January 2008
3680 \begin_layout Subsection*
3681 LFUN_IN_MATHMACROTEMPLATE
3684 \begin_layout Description
3685 Action Only active in Math Macro definition.
3688 \begin_layout Description
3689 Notion Dummy function which is only active in a Math Macro definition.
3690 It's used to toggle the Math Macro toolbar if the cursor moves into a Math
3694 \begin_layout Description
3695 Syntax in-mathmacrotemplate
3698 \begin_layout Description
3699 Origin sts, 06 January 2008
3702 \begin_layout Subsection*
3703 LFUN_PARAGRAPH_MOVE_DOWN
3706 \begin_layout Description
3707 Action Moves the current paragraph downwards in the document.
3710 \begin_layout Description
3711 Syntax paragraph-move-down
3714 \begin_layout Description
3715 Origin Edwin, 8 Apr 2006
3718 \begin_layout Subsection*
3719 LFUN_PARAGRAPH_MOVE_UP
3722 \begin_layout Description
3723 Action Moves the current paragraph upwards in the document.
3726 \begin_layout Description
3727 Notion Movement through the document will possibly break the paragraph-depth
3732 \begin_layout Description
3733 Syntax paragraph-move-up
3736 \begin_layout Description
3737 Origin Edwin, 8 Apr 2006
3740 \begin_layout Subsection*
3744 \begin_layout Description
3745 Action Move the cursor to the next paragraph (or beginning of the current
3746 one) in upward direction.
3749 \begin_layout Description
3753 \begin_layout Description
3754 Origin Asger, 1 Oct 1996
3757 \begin_layout Subsection*
3758 LFUN_PARAGRAPH_UP_SELECT
3761 \begin_layout Description
3762 Action Move the cursor and select the text to the next paragraph (or beginning
3763 of the current one) in upward direction.
3766 \begin_layout Description
3767 Syntax paragraph-up-select
3770 \begin_layout Description
3771 Origin Asger, 1 Oct 1996
3774 \begin_layout Subsection*
3778 \begin_layout Description
3779 Action Move the cursor to the next paragraph (or beginning of the current
3780 one) in downward direction.
3783 \begin_layout Description
3784 Syntax paragraph-down
3787 \begin_layout Description
3788 Origin Asger, 1 Oct 1996
3791 \begin_layout Subsection*
3792 LFUN_PARAGRAPH_DOWN_SELECT
3795 \begin_layout Description
3796 Action Move the cursor and select the text to the next paragraph (or beginning
3797 of the current one) in downward direction.
3800 \begin_layout Description
3801 Syntax paragraph-down-select
3804 \begin_layout Description
3805 Origin Asger, 1 Oct 1996
3808 \begin_layout Subsection*
3812 \begin_layout Description
3813 Action Jump to a paragraph given by its id number and optionally the desired
3814 position within the paragraph.
3817 \begin_layout Description
3818 Notion Note that id number of paragraph is not the sequential number of
3819 paragraph seen on the screen.
3820 Moreover the id is unique for all opened buffers (documents).
3823 \begin_layout Description
3824 Syntax paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
3827 \begin_layout Description
3828 Params <PAR_ID_NUMBER>: paragraph id
3829 \begin_inset Newline newline
3832 <POSITION_IN_PAR>: desired position within the paragraph
3835 \begin_layout Description
3836 Origin Dekel, 26 Aug 2000
3839 \begin_layout Subsection*
3840 LFUN_PARAGRAPH_BREAK
3843 \begin_layout Description
3844 Action Breaks the current paragraph at the current location.
3847 \begin_layout Description
3848 Notion Removes the selection.
3851 \begin_layout Description
3852 Syntax paragraph-break [<LAYOUT>]
3855 \begin_layout Description
3856 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to
3857 default layout) when the cursor is at the end of the line.
3860 \begin_layout Subsection*
3861 LFUN_PARAGRAPH_PARAMS
3864 \begin_layout Description
3865 Action Change paragraph settings.
3868 \begin_layout Description
3869 Notion Modifies the current paragraph, or currently selected paragraphs.
3870 This function only modifies, and does not override, existing settings.
3871 Note that the "leftindent" indent setting is deprecated.
3874 \begin_layout Description
3875 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
3878 \begin_layout Description
3888 \begin_inset Newline newline
3893 paragraph_spacing default|single|onehalf|double|other SIZE
3894 \begin_inset Newline newline
3899 align block|left|right|center|default
3900 \begin_inset Newline newline
3905 labelwidthstring WIDTH|
3910 \begin_layout Description
3911 Origin rgh, Aug 15 2007
3914 \begin_layout Subsection*
3915 LFUN_PARAGRAPH_PARAMS_APPLY
3918 \begin_layout Description
3919 Action Change paragraph settings.
3922 \begin_layout Description
3923 Notion Overwrite all nonspecified settings to the default ones.
3924 Use paragraph-params lfun if you don't want to overwrite others settings.
3927 \begin_layout Description
3928 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
3931 \begin_layout Description
3932 Params For parameters see LFUN_PARAGRAPH_PARAMS
3935 \begin_layout Description
3936 Origin leeming, 30 Mar 2004
3939 \begin_layout Subsection*
3940 LFUN_PARAGRAPH_UPDATE
3943 \begin_layout Description
3944 Action Updates the values inside the paragraph dialog from the paragraph.
3947 \begin_layout Description
3948 Notion This is an internal LFUN, not to be used by users.
3949 Called internally by LFUN_DIALOG_UPDATE.
3952 \begin_layout Description
3953 Origin leeming, 13 Mar 2003
3956 \begin_layout Subsection*
3960 \begin_layout Description
3961 Action Move the current group in the upward direction in the structure of
3965 \begin_layout Description
3966 Notion The "group" can be Part/Chapter/Section/etc.
3967 It moves the whole substructure of the group.
3970 \begin_layout Description
3974 \begin_layout Description
3975 Origin Vermeer, 23 Mar 2006
3978 \begin_layout Subsection*
3982 \begin_layout Description
3983 Action Move the current group in the downward direction in the structure
3987 \begin_layout Description
3988 Notion The "group" can be Part/Chapter/Section/etc.
3989 It moves the whole substructure of the group.
3992 \begin_layout Description
3996 \begin_layout Description
3997 Origin Vermeer, 23 Mar 2006
4000 \begin_layout Subsection*
4004 \begin_layout Description
4005 Action Moves the current group in the downward direction in the hierarchy
4006 of the document structure.
4009 \begin_layout Description
4010 Notion Part -> Chapter -> Section -> etc.
4013 \begin_layout Description
4017 \begin_layout Description
4018 Origin Vermeer, 23 Mar 2006
4021 \begin_layout Subsection*
4025 \begin_layout Description
4026 Action Moves the current group in the upward direction in the hierarchy
4027 of the document structure.
4030 \begin_layout Description
4031 Notion Part <- Chapter <- Section <- etc.
4034 \begin_layout Description
4038 \begin_layout Description
4039 Origin Vermeer, 23 Mar 2006
4042 \begin_layout Subsection*
4046 \begin_layout Description
4047 Action Edit the inset at cursor with an external application, if one is
4051 \begin_layout Description
4052 Syntax inset-edit [<INSET_PARAMS>]
4055 \begin_layout Description
4056 Params <INSET_PARAMS>: Parameters for the inset.
4057 \begin_inset Newline newline
4060 Currently only the filename will be considered.
4063 \begin_layout Description
4064 Origin JSpitzm, 27 Apr 2006
4067 \begin_layout Subsection*
4071 \begin_layout Description
4072 Action Inserts table into the document.
4075 \begin_layout Description
4076 Notion See LFUN_INSET_MODIFY for some more details about tabular modifications.
4079 \begin_layout Description
4080 Syntax tabular-insert [<ROWS> <COLUMNS>]
4083 \begin_layout Description
4084 Params In case no arguments are given show insert dialog.
4087 \begin_layout Description
4088 Origin Jug, 12 Apr 2000
4091 \begin_layout Subsection*
4095 \begin_layout Description
4096 Action Moves the cursor to the previous cell inside the table.
4099 \begin_layout Description
4100 Syntax cell-backward
4103 \begin_layout Description
4104 Origin Jug, 22 May 2000
4107 \begin_layout Subsection*
4111 \begin_layout Description
4112 Action Moves the cursor to the next cell inside the table.
4115 \begin_layout Description
4119 \begin_layout Subsection*
4123 \begin_layout Description
4124 Action Splits cell and shifts right part to the next cell (inside the math
4128 \begin_layout Description
4132 \begin_layout Description
4133 Origin Ale, 15 May 1997
4136 \begin_layout Subsection*
4140 \begin_layout Description
4141 Action Register the document as an file inside version control system.
4144 \begin_layout Description
4145 Notion File is registered inside cvs, svn or rcs repository acording to
4146 the existence of cvs/svn/rcs entries in the document's directory.
4147 \begin_inset Newline newline
4150 See LyX Additional Features Manual (Version Control Chapter) for additional
4154 \begin_layout Description
4158 \begin_layout Description
4159 Origin Lgb, 1 Jul 1997
4162 \begin_layout Subsection*
4166 \begin_layout Description
4167 Action Renames the document to another name.
4170 \begin_layout Description
4171 Notion Renaming with revision history is only supported by SVN.
4172 For CVS it is simulated by adding the document under a new name and deleting
4174 For RCS it is not supported.
4175 Disabled if uncommitted changes exist.
4178 \begin_layout Description
4179 Syntax vc-rename <FILENAME>
4182 \begin_layout Description
4183 Params <FILENAME>: New name of the document.
4184 \begin_inset Newline newline
4187 A file dialog is opened if no filename is given.
4190 \begin_layout Description
4191 Origin gb, 05 Feb 2013
4194 \begin_layout Subsection*
4198 \begin_layout Description
4199 Action Copies the document to another name.
4202 \begin_layout Description
4203 Notion Copying with revision history is only supported by SVN.
4204 For RCS and CVS it is simulated by adding the document under a new name.
4205 Disabled if uncommitted changes exist.
4208 \begin_layout Description
4209 Syntax vc-copy <FILENAME>
4212 \begin_layout Description
4213 Params <FILENAME>: New name of the document.
4214 \begin_inset Newline newline
4217 A file dialog is opened if no filename is given.
4220 \begin_layout Description
4221 Origin gb, 05 Feb 2013
4224 \begin_layout Subsection*
4228 \begin_layout Description
4229 Action Checks-in/commits the changes of the registered file to the repository.
4232 \begin_layout Description
4233 Notion In RCS case this also unlocks the file.
4236 \begin_layout Description
4240 \begin_layout Description
4241 Origin Lgb, 1 Jul 1997
4244 \begin_layout Subsection*
4248 \begin_layout Description
4249 Action Checks-out the document for edit (and locks it in some cases).
4252 \begin_layout Description
4256 \begin_layout Description
4257 Origin Lgb, 1 Jul 1997
4260 \begin_layout Subsection*
4264 \begin_layout Description
4265 Action Reverts the document to the last check-in/commit in VCS.
4268 \begin_layout Description
4272 \begin_layout Description
4273 Origin Lgb, 1 Jul 1997
4276 \begin_layout Subsection*
4280 \begin_layout Description
4281 Action Undo last check-in.
4284 \begin_layout Description
4285 Notion This is currently implemented only for RCS.
4288 \begin_layout Description
4292 \begin_layout Description
4293 Origin Lgb, 1 Jul 1997
4296 \begin_layout Subsection*
4300 \begin_layout Description
4301 Action Executes external command.
4302 This command is intended to support additional VCS commands.
4305 \begin_layout Description
4306 Syntax vc-command <FLAG> <PATH> <COMMAND>
4309 \begin_layout Description
4310 Params <FLAG>: Flags for the command can be combined together.
4311 \begin_inset Newline newline
4314 U - dUmmy - no flags
4315 \begin_inset Newline newline
4318 D - Doc - need document loaded to proceed
4319 \begin_inset Newline newline
4322 I - dIrty - mark document dirty
4323 \begin_inset Newline newline
4326 R - Reload - ensure that the document is saved and reload it after command
4328 \begin_inset Newline newline
4331 M - Message - ask for input string (commit message)
4332 \begin_inset Newline newline
4335 <PATH>: path where to start.
4336 $$p will be replaced by the current document path.
4337 \begin_inset Newline newline
4340 <COMMAND>: command to execute.
4341 $$i/$$p/$$m will be replaced by the current document(with absolute path)/path/m
4345 \begin_layout Description
4346 Sample vc-command DR $$p "svn up"
4349 \begin_layout Description
4350 Origin sanda, 13 Jan 2009
4353 \begin_layout Subsection*
4354 LFUN_VC_LOCKING_TOGGLE
4357 \begin_layout Description
4358 Action Toggles the locking property of the edited file.
4361 \begin_layout Description
4362 Notion This is currently implemented only for SVN.
4365 \begin_layout Description
4366 Syntax vc-locking-toggle
4369 \begin_layout Description
4370 Origin sanda, 25 Jun 2009
4373 \begin_layout Subsection*
4377 \begin_layout Description
4378 Action Update the local archive directory in which resides the current document
4379 with the remote repository.
4382 \begin_layout Description
4383 Syntax vc-repo-update
4386 \begin_layout Description
4387 Origin sanda, 16 Oct 2009
4390 \begin_layout Subsection*
4394 \begin_layout Description
4395 Action Compares two revisions of the same file under version control.
4398 \begin_layout Description
4399 Syntax vc-compare [<REV1>] [<REV2>]
4402 \begin_layout Description
4403 Params Revision number either points directly to commit in history or if
4404 negative number -x it points to (last commit - x).
4405 \begin_inset Newline newline
4408 In RCS we subtract only in the last number of revision specification.
4409 Special case "0" is reserved for the last committed revision.
4410 \begin_inset Newline newline
4414 \begin_inset Newline newline
4418 Used only if REV1 > 0.
4419 \begin_inset Newline newline
4422 If no parameter is given, interactive dialog will be shown.
4425 \begin_layout Description
4426 Sample Compare current document against last commit
4427 \begin_inset Newline newline
4431 \begin_inset Newline newline
4434 Compare current document against current revision - 5 commits
4435 \begin_inset Newline newline
4439 \begin_inset Newline newline
4442 Compare revisions 120 and 155
4443 \begin_inset Newline newline
4449 \begin_layout Description
4450 Origin sanda, 12 Feb 2010
4453 \begin_layout Subsection*
4457 \begin_layout Description
4458 Action Toggles change tracking to on/off.
4461 \begin_layout Description
4462 Syntax changes-track
4465 \begin_layout Description
4466 Origin levon, 1 Oct 2002
4469 \begin_layout Subsection*
4473 \begin_layout Description
4474 Action Toggles showing of change tracking in typesetted output.
4477 \begin_layout Description
4478 Syntax changes-output
4481 \begin_layout Description
4482 Origin jspitzm, 21 Jan 2005
4485 \begin_layout Subsection*
4489 \begin_layout Description
4490 Action Moves the cursor to the position of the next change of the change
4494 \begin_layout Description
4498 \begin_layout Description
4499 Origin schmitt, 4 Oct 2006
4502 \begin_layout Subsection*
4503 LFUN_CHANGE_PREVIOUS
4506 \begin_layout Description
4507 Action Moves the cursor to the position of the previous change of the change
4511 \begin_layout Description
4512 Syntax change-previous
4515 \begin_layout Description
4516 Origin vfr, 4 Apr 2009
4519 \begin_layout Subsection*
4523 \begin_layout Description
4524 Action Open change tracking dialog for merging and moves the cursor to the
4525 position of the next change.
4528 \begin_layout Description
4529 Syntax changes-merge
4532 \begin_layout Description
4533 Origin Levon, 16 Oct 2002
4536 \begin_layout Subsection*
4540 \begin_layout Description
4541 Action Accepts tracked change inside the selection.
4544 \begin_layout Description
4545 Syntax change-accept
4548 \begin_layout Description
4549 Origin Levon, 16 Oct 2002
4552 \begin_layout Subsection*
4556 \begin_layout Description
4557 Action Rejects tracked change inside the selection.
4560 \begin_layout Description
4561 Syntax change-reject
4564 \begin_layout Description
4565 Origin Levon, 16 Oct 2002
4568 \begin_layout Subsection*
4569 LFUN_ALL_CHANGES_ACCEPT
4572 \begin_layout Description
4573 Action Accepts all tracked changes in the document.
4576 \begin_layout Description
4577 Syntax all-changes-accept
4580 \begin_layout Description
4581 Origin Levon, 16 Oct 2002
4584 \begin_layout Subsection*
4585 LFUN_ALL_CHANGES_REJECT
4588 \begin_layout Description
4589 Action Rejects all tracked changes in the document.
4592 \begin_layout Description
4593 Notion Reject does not work recursively; the user may have to repeat the
4597 \begin_layout Description
4598 Syntax all-changes-reject
4601 \begin_layout Description
4602 Origin Levon, 16 Oct 2002
4605 \begin_layout Subsection*
4609 \begin_layout Description
4610 Action Apply data for an inset.
4613 \begin_layout Description
4614 Notion LFUN_INSET_APPLY is sent from the dialogs when the data should be
4616 This is either changed to LFUN_INSET_MODIFY or LFUN_INSET_INSERT depending
4617 on the context where it is called.
4620 \begin_layout Description
4621 Syntax inset-apply <ARGS>
4624 \begin_layout Description
4625 Params See LFUN_INSET_INSERT .
4628 \begin_layout Subsection*
4632 \begin_layout Description
4633 Action Dissolve the current inset into text.
4636 \begin_layout Description
4637 Syntax inset-dissolve [<INSET>]
4640 \begin_layout Description
4641 Params <INSET>: this can be used to make sure the right kind of inset is
4643 For example "dissolve" entry in the charstyles sub-menu should only dissolve
4644 the charstyle inset, even if the cursor is inside several nested insets
4646 \begin_inset Newline newline
4649 For values see lyx::InsetLayout::lyxtype_ .
4652 \begin_layout Description
4653 Origin JSpitz, 7 Aug 2006
4656 \begin_layout Subsection*
4660 \begin_layout Description
4661 Action Insert new inset (type given by the parameters).
4664 \begin_layout Description
4665 Syntax inset-insert <INSET> <ARGS>
4668 \begin_layout Description
4669 Params <INSET>: <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|
4670 \begin_inset Newline newline
4673 hyperlink|include|index|label|line|nomencl|vspace|ref|toc|scri
4675 \begin_inset Newline newline
4678 <ARGS>: depends on the given inset.
4679 Use "lyx -dbg action" to explore.
4682 \begin_layout Description
4683 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
4686 \begin_inset Newline newline
4689 where <label name> is the name of the referenced label and <Format> is one
4691 \begin_inset Newline newline
4695 \begin_inset Newline newline
4698 eqref -- (<reference>)
4699 \begin_inset Newline newline
4703 \begin_inset Newline newline
4706 vpageref -- on <page>
4707 \begin_inset Newline newline
4710 vref -- <reference> on <page>
4711 \begin_inset Newline newline
4714 formatted -- Formatted reference
4717 \begin_layout Subsection*
4721 \begin_layout Description
4722 Action Modify some properties of an inset.
4725 \begin_layout Description
4726 Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats,
4727 graphics, include, index, info, label, listings, newline, newpage, nomencl,
4728 note, phantom, ref, space, tabular, vspace, wrap insets.
4731 \begin_layout Description
4732 Syntax inset-modify <INSET> <ARGS>inset-modify changetype <TYPE>inset-modify
4733 tabular <FEATURE> [<ARG>]
4736 \begin_layout Description
4737 Params Generally see LFUN_INSET_INSERT for further details.
4738 \begin_inset Newline newline
4741 In case that <INSET> is "tabular" various math-environment features are
4742 handled as well, e.g.
4743 add-vline-left/right for the Grid/Array environment.
4744 \begin_inset Newline newline
4747 <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|
4748 \begin_inset Newline newline
4751 copy-column|move-column-right|move-column-left|move-row-down|move-row-up|
4752 \begin_inset Newline newline
4755 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
4756 \begin_inset Newline newline
4759 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|
4760 \begin_inset Newline newline
4763 valign-top|valign-bottom|valign-middle|longtabular-align-left|
4764 \begin_inset Newline newline
4767 longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|
4768 \begin_inset Newline newline
4771 m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|
4772 \begin_inset Newline newline
4775 set-all-lines|unset-all-lines|set-longtabular|unset-longtabular|set-pwidth|
4776 \begin_inset Newline newline
4779 set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
4780 \begin_inset Newline newline
4783 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
4784 \begin_inset Newline newline
4787 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
4788 \begin_inset Newline newline
4791 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
4792 \begin_inset Newline newline
4795 set-special-column|set-special-multicolumn|set-special-multirow|
4796 \begin_inset Newline newline
4799 set-booktabs|unset-booktabs|set-top-space|set-bottom-space|
4800 \begin_inset Newline newline
4803 set-interline-space|set-border-lines|tabular-valign-top|
4804 \begin_inset Newline newline
4807 tabular-valign-middle|tabular-valign-bottom|set-tabular-width <ARG>: additional
4808 argument for some commands, use debug mode to explore its values.
4811 \begin_layout Description
4812 Sample inset-modify note Note Comment
4813 \begin_inset Newline newline
4816 inset-modify changetype Ovalbox
4819 \begin_layout Subsection*
4820 LFUN_INSET_DIALOG_UPDATE
4823 \begin_layout Description
4824 Action Updates the values inside the dialog from the inset.
4827 \begin_layout Description
4828 Notion This is an internal LFUN, not to be used by users.
4829 Called internally by LFUN_DIALOG_UPDATE
4832 \begin_layout Description
4833 Params <DIALOG-NAME>
4836 \begin_layout Description
4837 Origin leeming, 25 Feb 2003
4840 \begin_layout Subsection*
4844 \begin_layout Description
4845 Action Open the inset's properties dialog.
4848 \begin_layout Description
4849 Notion Used for bibitem, bibtex, box, branch, citation, ert, external, float,
4850 graphics, href, include, index, index_print, label, line, listings, note,
4851 phantom, ref, space, tabular, vspace, wrap insets.
4854 \begin_layout Description
4855 Syntax inset-settings <INSET>
4858 \begin_layout Description
4859 Params <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
4860 \begin_inset Newline newline
4863 graphics|href|include|index|index_print|label|line|
4864 \begin_inset Newline newline
4867 listings|note|phantom|ref|space|tabular|vspace|wrap>.
4870 \begin_layout Subsection*
4874 \begin_layout Description
4875 Action Toggles the collapsible inset at cursor position, or the inset we
4879 \begin_layout Description
4880 Syntax inset-toggle [<ARG>]
4883 \begin_layout Description
4884 Params <ARG>: <open|close|toggle|assign>.
4885 \begin_inset Newline newline
4888 open/close/toggle are for collapsible insets.
4889 toggle is used when no argument is given.
4890 \begin_inset Newline newline
4893 assign synchronize the branch-inset with activation status of the branch.
4894 Used for global toggling when changed activation.
4897 \begin_layout Description
4898 Origin lasgouttes, 19 Jul 2001
4901 \begin_layout Subsection*
4905 \begin_layout Description
4906 Action Apply the given commands on insets of a given name.
4909 \begin_layout Description
4910 Notion WARNING: use at your own risks; this function gives you too many
4911 ways of shooting yourself in the foot.
4912 A typical example is inset-forall Note note-insert which starts an infinite
4914 This is mitigated by the fact that the number of actions is arbitrarily
4916 Note also that inset-forall does not update metrics between iterations,
4917 which can lead to bugs.
4918 This has to be eventually fixed.
4921 \begin_layout Description
4922 Syntax inset-forall <NAME> <LFUN-COMMAND>
4923 \begin_inset Newline newline
4926 <NAME>: Type of Inset.
4927 If <NAME> is *, all insets are matched.
4928 The name is used like for InsetLayout in layout files: "Note" matches all
4929 note insets, while "Note:Note" only matches LyX yellow note insets.
4932 \begin_layout Description
4933 Sample Remove all index insets:
4934 \begin_inset Newline newline
4937 inset-forall Index char-delete-forward
4938 \begin_inset Newline newline
4941 Close all Notes (also works for a particular branch, for example):
4942 \begin_inset Newline newline
4945 inset-forall Note inset-toggle close
4946 \begin_inset Newline newline
4949 Transform all yellow notes to comments
4950 \begin_inset Newline newline
4953 inset-forall Note:Note inset-modify note Note Comment
4954 \begin_inset Newline newline
4957 Try to put LyX in an infinite loop if there is at least a Note:
4958 \begin_inset Newline newline
4961 inset-forall Note char-backward
4964 \begin_layout Description
4965 Origin lasgouttes, 27 Nov 2009
4968 \begin_layout Subsection*
4969 LFUN_GRAPHICS_RELOAD
4972 \begin_layout Description
4973 Action Reloads the image if necessary.
4976 \begin_layout Description
4977 Syntax graphics-reload
4980 \begin_layout Description
4981 Origin vfr, 10 Aug 2009
4984 \begin_layout Subsection*
4985 LFUN_SET_GRAPHICS_GROUP
4988 \begin_layout Description
4989 Action Set the group for the graphics inset on the cursor position.
4992 \begin_layout Description
4993 Syntax set-graphics-group [<GROUP>]
4996 \begin_layout Description
4997 Params <GROUP>: Id for an existing group.
4998 In case the Id is an empty string, the graphics inset is removed from the
5002 \begin_layout Description
5003 Origin sanda, 6 May 2008
5006 \begin_layout Subsection*
5007 LFUN_FINISHED_FORWARD
5010 \begin_layout Description
5011 Action Moves the cursor out of the current slice, going forward.
5014 \begin_layout Description
5015 Notion Cursor movement within an inset may be different than cursor movement
5016 in the surrounding text.
5017 This action should be called automatically by the cursor movement within
5018 the inset, when movement within the inset has ceased (reached the end of
5019 the last paragraph, for example), in order to move correctly back into
5020 the surrounding text.
5023 \begin_layout Subsection*
5024 LFUN_FINISHED_BACKWARD
5027 \begin_layout Description
5028 Action Moves the cursor out of the current slice, going backwards.
5031 \begin_layout Description
5032 Notion See also LFUN_FINISHED_FORWARD.
5035 \begin_layout Subsection*
5039 \begin_layout Description
5040 Action Moves the cursor out of the current slice, going right.
5043 \begin_layout Description
5044 Notion See also LFUN_FINISHED_FORWARD
5047 \begin_layout Subsection*
5051 \begin_layout Description
5052 Action Moves the cursor out of the current slice, going left.
5055 \begin_layout Description
5056 Notion See also LFUN_FINISHED_FORWARD.
5059 \begin_layout Subsection*
5063 \begin_layout Description
5064 Action Set language from the current cursor position.
5067 \begin_layout Description
5068 Syntax language <LANG> [set]
5071 \begin_layout Description
5072 Params <LANG>: Requested language.
5073 Look in lib/languages for the list.
5074 "language reset" or "language" (without param) reset to the document language.
5075 set: If used, the language will be set to the specified language.
5076 Otherwise, the language will be toggled (i.e., if the current language is
5077 LANG, switch to the document language or the default language, if LANG
5078 is the document language).
5081 \begin_layout Description
5082 Origin Dekel, 2 Mar 2000
5085 \begin_layout Subsection*
5089 \begin_layout Description
5090 Action Goto a label.
5093 \begin_layout Description
5094 Syntax label-goto [<LABEL>]
5097 \begin_layout Description
5098 Params <LABEL>: Requested label.
5099 If no label is given and reference is on cursor position, Bookmark 0 is
5100 saved and cursor moves to the position of referenced label.
5103 \begin_layout Description
5104 Origin Ale, 6 Aug 1997
5107 \begin_layout Subsection*
5111 \begin_layout Description
5112 Action Inserts label to text or displayed formula.
5115 \begin_layout Description
5116 Syntax label-insert [<LABEL>]
5119 \begin_layout Description
5120 Params <LABEL>: Requested label.
5121 If no label is given dialog requesting name will be opened.
5124 \begin_layout Subsection*
5128 \begin_layout Description
5129 Action Go to the next label or cross-reference.
5132 \begin_layout Description
5133 Syntax reference-next
5136 \begin_layout Description
5137 Origin Dekel, 14 Jan 2001
5140 \begin_layout Subsection*
5144 \begin_layout Description
5145 Action Moves the cursor to the numbered bookmark, opening the file if necessary.
5146 Note that bookmarks are saved per-session, not per file.
5149 \begin_layout Description
5150 Notion Bookmark 0 has a special purpose.
5151 It is automatically set
5152 \begin_inset Newline newline
5156 to the paragraph you are currently editing
5157 \begin_inset Newline newline
5161 to the paragraph from where you are jumping to the last-edited position
5163 \begin_inset Newline newline
5167 when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
5170 \begin_layout Description
5171 Syntax bookmark-goto <NUMBER>
5174 \begin_layout Description
5175 Params <NUMBER>: the number of the bookmark to restore.
5178 \begin_layout Description
5179 Origin Dekel, 27 January 2001
5182 \begin_layout Subsection*
5186 \begin_layout Description
5187 Action Save a bookmark.
5190 \begin_layout Description
5191 Notion Saves a numbered bookmark to the sessions file.
5192 The number must be between 1 and 9, inclusive.
5193 Note that bookmarks are saved per-session, not per file.
5196 \begin_layout Description
5197 Syntax bookmark-save <NUMBER>
5200 \begin_layout Description
5201 Params <NUMBER>: the number of the bookmark to save.
5204 \begin_layout Description
5205 Origin Dekel, 27 January 2001
5208 \begin_layout Subsection*
5212 \begin_layout Description
5213 Action Clears the list of saved bookmarks.
5216 \begin_layout Description
5217 Syntax bookmark-clear
5220 \begin_layout Description
5221 Origin bpeng, 31 October 2006
5224 \begin_layout Subsection*
5228 \begin_layout Description
5229 Action Open the given help file according to the language setting.
5232 \begin_layout Description
5233 Syntax help-open <FILE>[.lyx]
5236 \begin_layout Description
5237 Params <FILE>: any document from (/usr/share/)doc directory.
5240 \begin_layout Description
5241 Origin Jug, 27 Jun 1999
5244 \begin_layout Subsection*
5248 \begin_layout Description
5249 Action Terminates the current LyX instance.
5252 \begin_layout Description
5253 Notion Terminates the current LyX instance, asking whether to save modified
5257 \begin_layout Description
5261 \begin_layout Subsection*
5265 \begin_layout Description
5266 Action Toggles visibility of a given toolbar between on/off/auto.
5269 \begin_layout Description
5270 Notion Skipping "auto" when allowauto is false.
5273 \begin_layout Description
5274 Syntax toolbar-toggle <NAME> [allowauto]
5277 \begin_layout Description
5278 Params <NAME>: standard|extra|table|math|mathmacrotemplate|
5279 \begin_inset Newline newline
5282 minibuffer|review|view/update|math_panels|vcs| view-others|update-others
5285 \begin_layout Description
5286 Origin Edwin, 21 May 2007
5289 \begin_layout Subsection*
5293 \begin_layout Description
5294 Action Opens the menu given by its name.
5297 \begin_layout Description
5298 Syntax menu-open <NAME>
5301 \begin_layout Description
5302 Params <NAME>: menu name.
5303 See various .inc files in lib/ui for candidates.
5306 \begin_layout Subsection*
5310 \begin_layout Description
5311 Action Various UI visibility-toggling actions.
5314 \begin_layout Description
5315 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
5318 \begin_layout Description
5319 Params statusbar : Toggle visibility of the statusbar.
5320 \begin_inset Newline newline
5323 menubar : Toggle visibility of the menubar.
5324 \begin_inset Newline newline
5327 scrollbar : Toggle visibility of the scrollbar.
5328 \begin_inset Newline newline
5331 frame : Toggle visibility of the frames around editing window.
5332 \begin_inset Newline newline
5335 fullscreen : Toggle fullscreen mode.
5336 This also covers calling the previous functions.
5337 However LFUN_TOOLBAR_TOGGLE for the custom tweaks of the toolbars should
5341 \begin_layout Description
5342 Origin sanda, 9 Feb 2007
5345 \begin_layout Subsection*
5349 \begin_layout Description
5350 Action Creates new empty LyX window.
5353 \begin_layout Description
5354 Notion Already opened documents from the previous window can be found under
5358 \begin_layout Description
5359 Syntax window-new [<GEOMETRY>]
5362 \begin_layout Description
5363 Params <GEOMETRY>: pass the geometry of the window.
5364 This parameter is currently accepted only on Windows platform.
5367 \begin_layout Description
5368 Origin Abdel, 21 Oct 2006
5371 \begin_layout Subsection*
5375 \begin_layout Description
5376 Action Closes the current LyX window.
5379 \begin_layout Description
5383 \begin_layout Description
5384 Origin Abdel, 23 Oct 2006
5387 \begin_layout Subsection*
5391 \begin_layout Description
5392 Action Creates another split view of current buffer.
5395 \begin_layout Description
5396 Notion All split views act in the same way independently.
5399 \begin_layout Description
5400 Syntax view-split <vertical|horizontal>
5403 \begin_layout Description
5404 Params horizontal : The work areas are laid out side by side.
5405 \begin_inset Newline newline
5408 vertical : The work areas laid out vertically.
5411 \begin_layout Description
5412 Origin Abdel, 20 Feb 2008
5415 \begin_layout Subsection*
5419 \begin_layout Description
5420 Action Close the current document work area.
5423 \begin_layout Description
5424 Notion Close the current work area.
5425 If no other work areas are showing the buffer, then close the associated
5429 \begin_layout Description
5433 \begin_layout Description
5434 Origin Tommaso, 15 Sep 2012
5437 \begin_layout Subsection*
5438 LFUN_TAB_GROUP_CLOSE
5441 \begin_layout Description
5442 Action Close the current tab group.
5445 \begin_layout Description
5446 Notion This only closes the work areas, not the buffers themselves.
5447 The still opened buffers can be visualized in another tab group.
5450 \begin_layout Description
5451 Syntax tab-group-close
5454 \begin_layout Description
5455 Origin Abdel, 21 Feb 2008
5458 \begin_layout Subsection*
5462 \begin_layout Description
5463 Action Shows hidden dialog or creates new one for a given function/inset
5467 \begin_layout Description
5468 Syntax dialog-show <NAME> [<DATA>]
5471 \begin_layout Description
5472 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
5473 \begin_inset Newline newline
5476 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|
5477 \begin_inset Newline newline
5480 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimit
5482 \begin_inset Newline newline
5485 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|
5486 \begin_inset Newline newline
5489 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|
5490 \begin_inset Newline newline
5493 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL>
5494 \begin_inset Newline newline
5497 <SPECIAL>: latexlog|vclog
5498 \begin_inset Newline newline
5501 <DATA>: data, usually settings for the given dialog.
5502 Use debug mode for the details.
5505 \begin_layout Description
5506 Origin leeming, 17 Jun 2003
5509 \begin_layout Subsection*
5510 LFUN_DIALOG_SHOW_NEW_INSET
5513 \begin_layout Description
5514 Action Shows hidden dialog or create new one for a given inset settings
5518 \begin_layout Description
5519 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given
5523 \begin_layout Description
5524 Syntax dialog-show-new-inset <NAME> [<DATA>]
5527 \begin_layout Description
5528 Params See LFUN_DIALOG_SHOW .
5531 \begin_layout Description
5532 Origin leeming, 25 Feb 2003
5535 \begin_layout Subsection*
5539 \begin_layout Description
5540 Action Updates the dialog values from the inset/paragraph/document.
5543 \begin_layout Description
5544 Syntax dialog-update <NAME>
5547 \begin_layout Description
5548 Params <NAME>: paragraph|prefs|<INSET>
5549 \begin_inset Newline newline
5555 \begin_layout Description
5556 Origin leeming, 25 Feb 2003
5559 \begin_layout Subsection*
5563 \begin_layout Description
5564 Action Hides showed dialog.
5565 Counterpart to LFUN_DIALOG_SHOW .
5568 \begin_layout Description
5569 Syntax dialog-hide <NAME>
5572 \begin_layout Description
5573 Params See LFUN_DIALOG_SHOW .
5576 \begin_layout Description
5577 Origin leeming, 25 Feb 2003
5580 \begin_layout Subsection*
5584 \begin_layout Description
5585 Action Toggles dialog between showed/hidden state.
5588 \begin_layout Description
5589 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
5592 \begin_layout Description
5593 Syntax dialog-toggle <NAME> [<DATA>]
5596 \begin_layout Description
5597 Params See LFUN_DIALOG_SHOW .
5600 \begin_layout Description
5601 Origin JSpitzm, 30 Apr 2007
5604 \begin_layout Subsection*
5605 LFUN_DIALOG_DISCONNECT_INSET
5608 \begin_layout Description
5609 Action Closes opened connection to opened inset.
5612 \begin_layout Description
5613 Notion Connection is used for apply functions.
5616 \begin_layout Description
5617 Syntax dialog-disconnect-inset <INSET-NAME>
5620 \begin_layout Description
5621 Origin leeming, 25 Feb 2003
5624 \begin_layout Subsection*
5628 \begin_layout Description
5629 Action This function is called when mouse button is pressed (inside workarea).
5630 Action depends on the context.
5633 \begin_layout Description
5634 Notion This is an internal LFUN, not to be used by users.
5637 \begin_layout Description
5638 Origin Andre, 9 Aug 2002
5641 \begin_layout Subsection*
5645 \begin_layout Description
5646 Action This function is called when double click on mouse button is pressed
5648 Action depends on the context.
5651 \begin_layout Description
5652 Notion This is an internal LFUN, not to be used by users.
5655 \begin_layout Description
5656 Origin Andre, 9 Aug 2002
5659 \begin_layout Subsection*
5663 \begin_layout Description
5664 Action This function is called when triple click on mouse button is pressed
5666 Action depends on the context.
5669 \begin_layout Description
5670 Notion This is an internal LFUN, not to be used by users.
5673 \begin_layout Description
5674 Origin Andre, 9 Aug 2002
5677 \begin_layout Subsection*
5681 \begin_layout Description
5682 Action This function is called when mouse cursor is moving over the text.
5683 Action depends on the context.
5686 \begin_layout Description
5687 Notion This is an internal LFUN, not to be used by users.
5690 \begin_layout Description
5691 Origin Andre, 9 Aug 2002
5694 \begin_layout Subsection*
5698 \begin_layout Description
5699 Action This function is called when mouse button is released (inside workarea).
5700 Action depends on the context.
5703 \begin_layout Description
5704 Notion This is an internal LFUN, not to be used by users.
5707 \begin_layout Description
5708 Origin Andre, 9 Aug 2002
5711 \begin_layout Subsection*
5715 \begin_layout Description
5716 Action Turn off the loaded keyboard map.
5719 \begin_layout Description
5723 \begin_layout Subsection*
5727 \begin_layout Description
5728 Action Turn on the primary keyboard map.
5731 \begin_layout Description
5732 Notion Maps were widely used in past, when X-windows didn't have nowadays
5734 They can be still used to maintain uniform keyboard layout across the various
5736 \begin_inset Newline newline
5739 The language is to be set in the Preferences dialog.
5742 \begin_layout Description
5743 Syntax keymap-primary
5746 \begin_layout Subsection*
5747 LFUN_KEYMAP_SECONDARY
5750 \begin_layout Description
5751 Action Turn on the secondary keyboard map.
5754 \begin_layout Description
5755 Syntax keymap-secondary
5758 \begin_layout Subsection*
5762 \begin_layout Description
5763 Action Toggles keyboard maps (first/second/off).
5766 \begin_layout Description
5767 Syntax keymap-toggle
5770 \begin_layout Description
5771 Origin leeming, 30 Mar 2004
5774 \begin_layout Subsection*
5775 LFUN_SERVER_GET_LAYOUT
5778 \begin_layout Description
5779 Action Returns the current layout (that is environment) name on the cursor
5783 \begin_layout Description
5784 Syntax server-get-layout
5787 \begin_layout Subsection*
5788 LFUN_SERVER_GET_FILENAME
5791 \begin_layout Description
5792 Action Returns path and file name of the currently edited document.
5795 \begin_layout Description
5796 Syntax server-get-filename
5799 \begin_layout Subsection*
5800 LFUN_SERVER_GOTO_FILE_ROW
5803 \begin_layout Description
5804 Action Sets the cursor position in LyX based on the row number of generated
5808 \begin_layout Description
5809 Notion This can be useful for DVI inverse-search or detection of the problematic
5810 line from LaTeX compilation.
5811 Note that before this function can be used export to LaTeX output must
5812 occur (in order to map the row numbers).
5815 \begin_layout Description
5816 Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
5819 \begin_layout Description
5820 Params <FILE>: the path and filename.
5821 Environment variables are expanded in the path.
5822 In case this LFUN does not work make sure you are giving correct path to
5824 \begin_inset Newline newline
5827 If the file is located inside LyX temporary directory it will be mapped
5828 back into the appropriate opened buffer (e.g.
5829 for the case of generated .tex file).
5830 \begin_inset Newline newline
5833 .ext: extensions will be automatically replaced by .lyx.
5834 \begin_inset Newline newline
5837 <ROW_NUMBER> The row number of the LaTeX file to which to go.
5840 \begin_layout Description
5841 Sample server-goto-file-row /home/user/example.lyx 41
5842 \begin_inset Newline newline
5845 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
5848 \begin_layout Description
5849 Origin Edmar, 23 Dec 1998
5852 \begin_layout Subsection*
5856 \begin_layout Description
5857 Action Sets the cursor position in the previewed (dvi/pdf) file based on
5858 the row number in LyX window.
5861 \begin_layout Description
5862 Notion The external program used for forward search call can be specified
5863 in LyX Output preferences.
5864 See Additional manual for details of these settings.
5867 \begin_layout Description
5868 Syntax forward-search
5871 \begin_layout Description
5872 Origin sanda, 14 Apr 2010
5875 \begin_layout Subsection*
5879 \begin_layout Description
5880 Action Sends notify message about the last key-sequence to client.
5883 \begin_layout Description
5884 Notion This can be used to grab last key-sequence used inside the LyX window.
5885 See also Debug extensions section in Additional features manual.
5888 \begin_layout Description
5889 Syntax server-notify
5892 \begin_layout Subsection*
5896 \begin_layout Description
5897 Action Sets the cursor position based on the editing area coordinates (similar
5898 to clicking on that point with left mouse button).
5901 \begin_layout Description
5902 Syntax server-set-xy <X> <Y>
5905 \begin_layout Subsection*
5909 \begin_layout Description
5910 Action Returns the coordinates of cursor position in the editing area.
5913 \begin_layout Description
5914 Syntax server-get-xy
5917 \begin_layout Subsection*
5921 \begin_layout Description
5922 Action Generates the code (literate programming).
5925 \begin_layout Description
5926 Notion Latex file with extension
5928 literate_extension is generated.
5931 build_command (with a default of ``make'') to generate the code and
5933 build_error_filter to process the compilation error messages.
5934 \begin_inset Newline newline
5937 In case you want to process your literate file with a script, or some other
5938 program, just insert in your lyxrc file an entry with:
5939 \begin_inset Newline newline
5944 build_command "my_script my_arguments"
5945 \begin_inset Newline newline
5950 build_error_filter differs from the
5952 literate_error_filter only in that the former will identify error messages
5956 \begin_layout Description
5957 Syntax build-program
5960 \begin_layout Subsection*
5961 LFUN_BUFFER_AUTO_SAVE
5964 \begin_layout Description
5965 Action Saves the current buffer to a temporary file.
5968 \begin_layout Description
5969 Notion Saves the current buffer to a file named "#filename#".
5970 This LFUN is called automatically by LyX, to "autosave" the current buffer.
5973 \begin_layout Description
5974 Syntax buffer-auto-save
5977 \begin_layout Subsection*
5978 LFUN_BUFFER_CHILD_OPEN
5981 \begin_layout Description
5982 Action Loads the given child document.
5985 \begin_layout Description
5986 Notion The current document is treated as a parent.
5989 \begin_layout Description
5990 Syntax buffer-child-open <FILE>
5993 \begin_layout Description
5994 Params <FILE>: Filename of the child.
5995 The directory of the parent is assumed by default.
5998 \begin_layout Description
5999 Origin Ale, 28 May 1997
6002 \begin_layout Subsection*
6006 \begin_layout Description
6007 Action Runs chktex for the current document.
6010 \begin_layout Description
6011 Syntax buffer-chktex
6014 \begin_layout Description
6015 Origin Asger, 30 Oct 1997
6018 \begin_layout Subsection*
6019 LFUN_BUFFER_TOGGLE_COMPRESSION
6022 \begin_layout Description
6023 Action Toggles compression of the current document on/off.
6026 \begin_layout Description
6027 Syntax buffer-toggle-compression
6030 \begin_layout Description
6031 Origin bpeng, 27 Apr 2006
6034 \begin_layout Subsection*
6035 LFUN_BUFFER_TOGGLE_OUTPUT_SYNC
6038 \begin_layout Description
6039 Action Toggles including of resources for forward/reverse search of the
6043 \begin_layout Description
6044 Notion When toggled on, SyncTeX is invoked for PDF, while srcltx package
6046 Custom LaTeX macro can be defined in preferences.
6049 \begin_layout Description
6050 Syntax buffer-toggle-output-sync
6053 \begin_layout Description
6054 Origin sanda, 25 May 2010
6057 \begin_layout Subsection*
6061 \begin_layout Description
6062 Action Closes the current buffer.
6065 \begin_layout Description
6066 Notion Closes the current buffer, asking whether to save it, etc, if the
6067 buffer has been modified.
6070 \begin_layout Description
6074 \begin_layout Subsection*
6075 LFUN_BUFFER_CLOSE_ALL
6078 \begin_layout Description
6079 Action Closes all buffers.
6082 \begin_layout Description
6083 Notion Closes all buffers, asking whether to save it, etc, if a buffer has
6087 \begin_layout Description
6088 Syntax buffer-close-all
6091 \begin_layout Subsection*
6095 \begin_layout Description
6096 Action Exports the current buffer (document) to the given format.
6099 \begin_layout Description
6100 Syntax buffer-export <FORMAT> [<DEST>]
6103 \begin_layout Description
6104 Params <FORMAT> is either "custom" or one of the formats which you can find
6105 in Tools->Preferences->File formats->Format.
6106 Usual format you will enter is "pdf2" (pdflatex), "pdflatex" (plain tex
6107 for pdflatex) or "ps" for postscript.
6108 \begin_inset Newline newline
6111 In case of "custom" you will be asked for a format you want to start from
6112 and for the command that you want to apply to this format.
6113 Internally the control is then passed to LFUN_BUFFER_EXPORT_CUSTOM.
6114 <DEST> If present, this argument provides the export destination filename.
6115 Its containing folder will also be the destination folder, where all
6116 the needed external files will be copied.
6119 \begin_layout Description
6120 Origin Lgb, 29 Jul 1997
6123 \begin_layout Subsection*
6124 LFUN_BUFFER_EXPORT_CUSTOM
6127 \begin_layout Description
6128 Action Exports the current buffer (document) from the given format using
6129 the given command on it.
6132 \begin_layout Description
6133 Syntax buffer-export-custom <FORMAT> <COMMAND>
6136 \begin_layout Description
6137 Params <FORMAT> format to start from (LyX will care to produce such intermediate
6139 \begin_inset Newline newline
6142 <COMMAND> this command will be launched on the file.
6143 Note that you can use "$$FName" string to qualify the intermediate file.
6146 \begin_layout Description
6147 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
6150 \begin_layout Description
6151 Origin leeming, 27 Mar 2004
6154 \begin_layout Subsection*
6155 LFUN_BUFFER_EXPORT_AS
6158 \begin_layout Description
6159 Action Pops up a dialog for exporting the current buffer.
6162 \begin_layout Description
6163 Syntax buffer-export-as
6166 \begin_layout Description
6167 Origin tommaso, 6 Oct 2011
6170 \begin_layout Subsection*
6174 \begin_layout Description
6175 Action Prints the current document.
6178 \begin_layout Description
6179 Notion Many settings can be given via the preferences dialog.
6182 \begin_layout Description
6183 Syntax buffer-print <TARGET> <TARGET-NAME> <COMMAND>
6186 \begin_layout Description
6187 Params <TARGET> is either "printer" or "file".
6188 \begin_inset Newline newline
6191 <TARGER-NAME> is either "default" or file name or printer name.
6192 \begin_inset Newline newline
6195 <COMMAND> command ensuring the printing job.
6198 \begin_layout Description
6199 Sample buffer-print file "/trash/newfile1.ps" "dvips"
6202 \begin_layout Description
6203 Origin leeming, 28 Mar 2004
6206 \begin_layout Subsection*
6210 \begin_layout Description
6211 Action Import a given file as a lyx document.
6214 \begin_layout Description
6215 Notion File can be imported iff lyx file format is (transitively) reachable
6216 via defined converters in preferences.
6217 Look in the File->Import menu to get an idea of the currently active import
6221 \begin_layout Description
6222 Syntax buffer-import <FORMAT> [<FILE>]
6225 \begin_layout Description
6226 Origin Asger, 24 Jul 1998
6229 \begin_layout Subsection*
6233 \begin_layout Description
6234 Action Creates a new buffer (that is, document) and switches to it.
6237 \begin_layout Description
6238 Notion Implicit path can be set in Preferences dialog.
6241 \begin_layout Description
6242 Syntax buffer-new [<FILE>]
6245 \begin_layout Description
6246 Params <FILE>: filename of created file with absolute path.
6249 \begin_layout Subsection*
6250 LFUN_BUFFER_NEW_TEMPLATE
6253 \begin_layout Description
6254 Action Creates a new buffer (that is, document) from a template.
6257 \begin_layout Description
6258 Notion Path for new files and templates can be set in Preferences dialog.
6259 Template will be asked for via Open-dialog.
6262 \begin_layout Description
6263 Syntax buffer-new-template [<FILE>]
6266 \begin_layout Description
6267 Params <FILE>: filename of created file with absolute path.
6270 \begin_layout Subsection*
6274 \begin_layout Description
6275 Action Reverts opened document.
6278 \begin_layout Description
6279 Syntax buffer-reload
6282 \begin_layout Description
6283 Origin Asger, 2 Feb 1997
6286 \begin_layout Subsection*
6290 \begin_layout Description
6291 Action Display and switch to the given buffer.
6294 \begin_layout Description
6295 Syntax buffer-switch <BUFFER>
6298 \begin_layout Description
6299 Params <BUFFER>: path and filename of already opened (but possibly hidden)
6300 document which is to be shown.
6303 \begin_layout Subsection*
6304 LFUN_BUFFER_TOGGLE_READ_ONLY
6307 \begin_layout Description
6308 Action Toggle editing mode of the current document between read/write and
6312 \begin_layout Description
6313 Notion This function is not allowed if the file is under version control,
6314 since read-only flag is often used in version control file locking.
6317 \begin_layout Description
6318 Syntax buffer-toggle-read-only
6321 \begin_layout Description
6322 Origin Lgb, 27 May 1997
6325 \begin_layout Subsection*
6329 \begin_layout Description
6330 Action Displays current buffer in chosen format.
6333 \begin_layout Description
6334 Notion Displays the contents of the current buffer in the chosen format,
6335 for example, PDF or DVI.
6336 This runs the necessary converter, calls the defined viewer, and so forth.
6339 \begin_layout Description
6340 Syntax buffer-view [<FORMAT>]
6343 \begin_layout Description
6344 Params <FORMAT>: The format to display, where this is one of the formats
6345 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
6346 If no format is given, the default format as specified in the same dialog
6350 \begin_layout Subsection*
6354 \begin_layout Description
6355 Action Exports the current document and put the result into the temporary
6359 \begin_layout Description
6360 Notion In case you are already viewing the exported document (see LFUN_BUFFER_VI
6361 EW) the output will be rewritten - updated.
6362 This is useful in case your viewer is able to detect such changes (e.g.
6363 ghostview for postscript).
6366 \begin_layout Description
6367 Syntax buffer-update [<FORMAT>]
6370 \begin_layout Description
6371 Params <FORMAT>: The format to display, where this is one of the formats
6372 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
6373 If no format is given, the default format as specified in the same dialog
6377 \begin_layout Description
6378 Origin Dekel, 5 Aug 2000
6381 \begin_layout Subsection*
6385 \begin_layout Description
6386 Action Saves the current buffer.
6389 \begin_layout Description
6390 Notion Saves the current buffer to disk, using the filename that is already
6391 associated with the buffer, asking for one if none is yet assigned.
6394 \begin_layout Description
6398 \begin_layout Subsection*
6399 LFUN_BUFFER_WRITE_AS
6402 \begin_layout Description
6403 Action Rename and save current buffer.
6406 \begin_layout Description
6407 Syntax buffer-write-as <FILENAME>
6410 \begin_layout Description
6411 Params <FILENAME>: New name of the buffer/file.
6412 A relative path is with respect to the original location of the buffer/file.
6415 \begin_layout Subsection*
6419 \begin_layout Description
6420 Action Applies a command to all non-hidden buffers.
6423 \begin_layout Description
6424 Notion a buffer is `hidden' if it is internally open in LyX, but not visible
6428 \begin_layout Description
6429 Syntax buffer-forall <LFUN-COMMAND>
6432 \begin_layout Description
6433 Params <LFUN-COMMAND>: The command to be applied to the buffers.
6436 \begin_layout Description
6437 Sample Close all Notes in buffers:
6438 \begin_inset Newline newline
6441 buffer-forall inset-forall Note inset-toggle close
6442 \begin_inset Newline newline
6445 Toggle change tracking on buffers:
6446 \begin_inset Newline newline
6449 buffer-forall changes-track
6450 \begin_inset Newline newline
6453 Toggle read-only for buffers:
6454 \begin_inset Newline newline
6457 buffer-forall buffer-toggle-read-only
6458 \begin_inset Newline newline
6461 Show statistics for individual buffers:
6462 \begin_inset Newline newline
6465 buffer-forall statistics
6466 \begin_inset Newline newline
6469 Activate the branch named "Solutions" in buffers:
6470 \begin_inset Newline newline
6473 buffer-forall branch-activate Solutions
6474 \begin_inset Newline newline
6477 Export buffers to PDF (pdflatex):
6478 \begin_inset Newline newline
6481 buffer-forall buffer-export pdf2
6482 \begin_inset Newline newline
6488 \begin_layout Description
6489 Origin scottkostyshak, 20 Jul 2012
6492 \begin_layout Subsection*
6493 LFUN_BUFFER_WRITE_ALL
6496 \begin_layout Description
6497 Action Save all changed documents.
6500 \begin_layout Description
6501 Syntax buffer-write-all
6504 \begin_layout Description
6505 Origin rgh, gpothier 6 Aug 2007
6508 \begin_layout Subsection*
6512 \begin_layout Description
6513 Action Switch to the next opened document.
6516 \begin_layout Description
6517 Notion Note that this does not necessarily mean next in tabbar (for full
6518 list see View menu).
6521 \begin_layout Description
6525 \begin_layout Subsection*
6526 LFUN_BUFFER_PREVIOUS
6529 \begin_layout Description
6530 Action Switch to the previous opened document.
6533 \begin_layout Description
6534 Syntax buffer-previous
6537 \begin_layout Subsection*
6538 LFUN_MASTER_BUFFER_UPDATE
6541 \begin_layout Description
6542 Action When run from a child document, this updates (exports) document built
6543 from the master buffer, if available.
6546 \begin_layout Description
6547 Syntax master-buffer-update [<FORMAT>]
6550 \begin_layout Description
6551 Params <FORMAT>: The format to display, where this is one of the formats
6552 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
6553 If no format is given, the default format as specified in the same dialog
6557 \begin_layout Description
6558 Origin Tommaso, 20 Sep 2007
6561 \begin_layout Subsection*
6562 LFUN_MASTER_BUFFER_VIEW
6565 \begin_layout Description
6566 Action When run from a child document, this command shows a preview built
6567 from the master buffer, if available.
6570 \begin_layout Description
6571 Syntax master-buffer-view [<FORMAT>]
6574 \begin_layout Description
6575 Params <FORMAT>: The format to display, where this is one of the formats
6576 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
6577 If no format is given, the default format as specified in the same dialog
6581 \begin_layout Description
6582 Origin Tommaso, 20 Sep 2007
6585 \begin_layout Subsection*
6586 LFUN_BUFFER_LANGUAGE
6589 \begin_layout Description
6590 Action Set language of the current document.
6593 \begin_layout Description
6594 Syntax buffer-language <LANG>
6597 \begin_layout Description
6598 Params <LANG>: language name.
6599 See lib/languages for list.
6602 \begin_layout Description
6603 Origin leeming, 30 Mar 2004
6606 \begin_layout Subsection*
6607 LFUN_BUFFER_SAVE_AS_DEFAULT
6610 \begin_layout Description
6611 Action Save the current document settings as default.
6614 \begin_layout Description
6615 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
6618 \begin_layout Description
6619 Syntax buffer-save-as-default [<ARGS>]
6622 \begin_layout Description
6623 Params <ARGS>: contains the particular settings to be saved.
6624 They obey the syntax you can find in document header of usual .lyx file.
6627 \begin_layout Description
6628 Origin leeming, 30 Mar 2004
6631 \begin_layout Subsection*
6632 LFUN_BUFFER_PARAMS_APPLY
6635 \begin_layout Description
6636 Action Apply the given settings to the current document.
6639 \begin_layout Description
6640 Syntax buffer-params-apply [<ARGS>]
6643 \begin_layout Description
6644 Params <ARGS>: contains the particular settings to be saved.
6645 They obey the syntax you can find in document header of usual .lyx file.
6648 \begin_layout Description
6649 Origin leeming, 30 Mar 2004
6652 \begin_layout Subsection*
6656 \begin_layout Description
6657 Action Inserts another LyX file.
6660 \begin_layout Description
6661 Syntax file-insert [<FILE>]
6664 \begin_layout Description
6665 Params <FILE>: Filename to be inserted.
6668 \begin_layout Subsection*
6669 LFUN_FILE_INSERT_PLAINTEXT
6672 \begin_layout Description
6673 Action Inserts plain text file.
6676 \begin_layout Description
6677 Syntax file-insert-plaintext [<FILE>]
6680 \begin_layout Description
6681 Params <FILE>: Filename to be inserted.
6684 \begin_layout Description
6685 Origin CFO-G, 19 Nov 1997
6688 \begin_layout Subsection*
6689 LFUN_FILE_INSERT_PLAINTEXT_PARA
6692 \begin_layout Description
6693 Action Inserts plain text file as paragraph (i.e.
6697 \begin_layout Description
6698 Syntax file-insert-plaintext-para [<FILE>]
6701 \begin_layout Description
6702 Params <FILE>: Filename to be inserted.
6705 \begin_layout Description
6706 Origin Levon, 14 Feb 2001
6709 \begin_layout Subsection*
6713 \begin_layout Description
6714 Action Open LyX document.
6717 \begin_layout Description
6718 Syntax file-open [<FILE>]
6721 \begin_layout Description
6722 Params <FILE>: Filename to be opened.
6725 \begin_layout Subsection*
6729 \begin_layout Description
6730 Action Executes a command defined in a .def file.
6733 \begin_layout Description
6734 Notion The definitions are by default read from lib/commands/default.def.
6735 \begin_inset Newline newline
6738 A .def file allows to define a command with
6740 define "<NAME>" "<LFUN>" where <NAME> is the name of the new command and
6741 <LFUN> is the lfun code to be executed (see e.g.
6742 LFUN_COMMAND_SEQUENCE).
6745 def_file "FileName" allows to include another .def file.
6746 \begin_inset Newline newline
6749 This is particularly useful in connection with toolbar buttons: Since the
6750 name of the button image for this lfun is lib/images/commands/<NAME>.png
6751 this is the way to assign an image to a complex command-sequence.
6754 \begin_layout Description
6758 \begin_layout Description
6759 Params <NAME>: Name of the command that must be called.
6762 \begin_layout Description
6763 Origin broider, 2 Oct 2007
6766 \begin_layout Subsection*
6770 \begin_layout Description
6771 Action Simulate halting Meta key (Alt key on PCs).
6774 \begin_layout Description
6775 Notion Used for buffer editation not for GUI control.
6778 \begin_layout Description
6782 \begin_layout Subsection*
6786 \begin_layout Description
6787 Action Cancels sequence prepared by LFUN_META_PREFIX .
6790 \begin_layout Description
6794 \begin_layout Subsection*
6795 LFUN_COMMAND_EXECUTE
6798 \begin_layout Description
6799 Action Switches the focus to the minibuffer so that the user can type in
6801 If necessary, it opens the minibuffer toolbar.
6804 \begin_layout Description
6805 Notion Usually bound to M-x shortcut.
6808 \begin_layout Description
6809 Syntax command-execute
6812 \begin_layout Subsection*
6816 \begin_layout Description
6817 Action Return the current key sequence and available options as a string.
6820 \begin_layout Description
6821 Notion No options are added if no current map exists.
6822 \begin_inset Newline newline
6825 This is probably usable only with connection to lyxserver.
6828 \begin_layout Description
6829 Syntax command-prefix
6832 \begin_layout Subsection*
6833 LFUN_COMMAND_SEQUENCE
6836 \begin_layout Description
6837 Action Run more commands (LFUN and its parameters) in a sequence.
6840 \begin_layout Description
6841 Syntax command-sequence <CMDS>
6844 \begin_layout Description
6845 Params <CMDS>: Sequence of commands separated by semicolons.
6848 \begin_layout Description
6849 Sample command-sequence cut; ert-insert; self-insert
6851 ; paste; self-insert {}; inset-toggle;
6854 \begin_layout Description
6855 Origin Andre, 11 Nov 1999
6858 \begin_layout Subsection*
6859 LFUN_COMMAND_ALTERNATIVES
6862 \begin_layout Description
6863 Action Runs the first listed command that is enabled.
6866 \begin_layout Description
6867 Notion This can be used to bind multiple functions to a single key, and
6868 then which one is used will depend upon the context.
6871 \begin_layout Description
6872 Syntax command-alternatives <CMDS>
6875 \begin_layout Description
6876 Params <CMDS>: Sequence of commands separated by semicolons.
6879 \begin_layout Description
6880 Sample command-alternatives completion-accept;cell-forward
6883 \begin_layout Description
6884 Origin rgh, 24 September 2008
6887 \begin_layout Subsection*
6891 \begin_layout Description
6892 Action Shows message in statusbar (for script purposes).
6895 \begin_layout Description
6896 Syntax message <STRING>
6899 \begin_layout Description
6900 Origin Lgb, 8 Apr 2001
6903 \begin_layout Subsection*
6904 LFUN_DEBUG_LEVEL_SET
6907 \begin_layout Description
6908 Action Set debug output level.
6911 \begin_layout Description
6912 Syntax debug-level-set <LEVEL>
6915 \begin_layout Description
6916 Params <LEVEL>: comma separated list of levels or the correspondent number
6917 of their combination.
6918 0 is equivalent to disabling all debug events.
6919 See lyx -dbg for the current list of debug levels and their numbers.
6922 \begin_layout Description
6923 Origin sanda, 28 Dec 2009
6926 \begin_layout Subsection*
6927 LFUN_PREFERENCES_SAVE
6930 \begin_layout Description
6931 Action Save user preferences.
6934 \begin_layout Description
6935 Syntax preferences-save
6938 \begin_layout Description
6939 Origin Lgb, 27 Nov 1999
6942 \begin_layout Subsection*
6946 \begin_layout Description
6947 Action Reconfigure the automatic settings.
6950 \begin_layout Description
6954 \begin_layout Description
6955 Origin Asger, 14 Feb 1997
6958 \begin_layout Subsection*
6962 \begin_layout Description
6963 Action Apply the given settings to user preferences.
6966 \begin_layout Description
6967 Syntax lyxrc-apply <SETTINGS>
6970 \begin_layout Description
6971 Params <SETTINGS>: settings which are to be set.
6972 Take a look into ~/.lyx/preferences to get an idea which commands to use
6974 lyx::LyXRC::LyXRCTags has the list of possible commands.
6977 \begin_layout Subsection*
6978 LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
6981 \begin_layout Description
6982 Action Determine whether to keep cursor inside the editing window regardless
6983 of the scrollbar movement.
6986 \begin_layout Description
6987 Syntax toggle-cursor-follows-scrollbar
6990 \begin_layout Description
6991 Origin ARRae, 2 Dec 1997
6994 \begin_layout Subsection*
6998 \begin_layout Description
6999 Action Set the given LyX color to the color defined by the X11 name given.
7002 \begin_layout Description
7003 Notion A new color entry is created if the color is unknown.
7004 Color names can be stored as a part of user settings.
7007 \begin_layout Description
7008 Syntax set-color <LYX_NAME> <X11_NAME>
7011 \begin_layout Description
7012 Origin SLior, 11 Jun 2000
7015 \begin_layout Subsection*
7019 \begin_layout Description
7020 Action Count the statistics (number of words and characters) in the document
7021 or in the given selection.
7024 \begin_layout Description
7025 Notion Note that this function gives the number of words/chars written,
7026 not the number of characters which will be typeset.
7029 \begin_layout Description
7033 \begin_layout Description
7034 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
7037 \begin_layout Subsection*
7038 LFUN_COMPLETION_INLINE
7041 \begin_layout Description
7042 Action Show the inline completion at the cursor position.
7045 \begin_layout Description
7046 Syntax completion-inline
7049 \begin_layout Description
7050 Origin sts, Feb 19 2008
7053 \begin_layout Subsection*
7054 LFUN_COMPLETION_POPUP
7057 \begin_layout Description
7058 Action Show the completion popup at the cursor position.
7061 \begin_layout Description
7062 Syntax completion-popup
7065 \begin_layout Description
7066 Origin sts, Feb 19 2008
7069 \begin_layout Subsection*
7070 LFUN_COMPLETION_COMPLETE
7073 \begin_layout Description
7074 Action Try to complete the word or command at the cursor position.
7077 \begin_layout Description
7081 \begin_layout Description
7082 Origin sts, Feb 19 2008
7085 \begin_layout Subsection*
7086 LFUN_COMPLETION_CANCEL
7089 \begin_layout Description
7090 Action Try to cancel completion, either the popup or the inline completion.
7093 \begin_layout Description
7094 Syntax completion-cancel
7097 \begin_layout Description
7098 Origin sts, Sep 07 2008
7101 \begin_layout Subsection*
7102 LFUN_COMPLETION_ACCEPT
7105 \begin_layout Description
7106 Action Accept suggested completion.
7109 \begin_layout Description
7110 Syntax completion-accept
7113 \begin_layout Description
7114 Origin sanda, Sep 08 2008
7117 \begin_layout Subsection*
7121 \begin_layout Description
7122 Action Add a branch to the buffer's BranchList.
7125 \begin_layout Description
7126 Syntax branch-add <BRANCH>
7129 \begin_layout Description
7130 Params <BRANCH>: Name of the branch to add
7133 \begin_layout Description
7134 Origin spitz, 7 Jul 2009
7137 \begin_layout Subsection*
7138 LFUN_BRANCH_ACTIVATE
7141 \begin_layout Description
7142 Action Activate the branch.
7145 \begin_layout Description
7146 Syntax branch-activate <BRANCH>
7149 \begin_layout Description
7150 Params <BRANCH>: The branch to activate
7153 \begin_layout Description
7154 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
7155 \begin_inset Newline newline
7158 could be used to export a pdf with the answers branch included without one's
7159 having to open LyX and activate the branch manually.
7162 \begin_layout Description
7163 Origin rgh, 27 May 2008
7166 \begin_layout Subsection*
7167 LFUN_BRANCH_DEACTIVATE
7170 \begin_layout Description
7171 Action De-activate the branch.
7174 \begin_layout Description
7175 Syntax branch-deactivate <BRANCH>
7178 \begin_layout Description
7179 Params <BRANCH>: The branch to deactivate
7182 \begin_layout Description
7183 Origin rgh, 27 May 2008
7186 \begin_layout Subsection*
7187 LFUN_BRANCH_MASTER_ACTIVATE
7190 \begin_layout Description
7191 Action Activate the branch in the master buffer.
7194 \begin_layout Description
7195 Syntax branch-master-activate <BRANCH>
7198 \begin_layout Description
7199 Params <BRANCH>: The branch to activate
7202 \begin_layout Description
7203 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
7204 \begin_inset Newline newline
7207 could be used to export a pdf with the answers branch included without one's
7208 having to open LyX and activate the branch manually.
7211 \begin_layout Description
7212 Origin spitz, 30 Sep 2012
7215 \begin_layout Subsection*
7216 LFUN_BRANCH_MASTER_DEACTIVATE
7219 \begin_layout Description
7220 Action De-activate the branch in the master buffer.
7223 \begin_layout Description
7224 Syntax branch-master-deactivate <BRANCH>
7227 \begin_layout Description
7228 Params <BRANCH>: The branch to deactivate
7231 \begin_layout Description
7232 Origin spitz, 30 Sep 2012
7235 \begin_layout Subsection*
7236 LFUN_BRANCHES_RENAME
7239 \begin_layout Description
7240 Action Rename all branches of a given name in a document.
7243 \begin_layout Description
7244 Syntax branches-rename <OLDNAME> <NEWNAME>
7247 \begin_layout Description
7248 Params <OLDNAME>: Current name of the branch to be renamed <NEWNAME>: New
7252 \begin_layout Description
7253 Origin spitz, 9 Jul 2009
7256 \begin_layout Subsection*
7257 LFUN_BRANCH_ADD_INSERT
7260 \begin_layout Description
7261 Action Create new branch and directly put the branch inset into the document.
7264 \begin_layout Description
7265 Syntax branch-add-insert [<NAME>]
7268 \begin_layout Description
7269 Params <NAME>: Branch name.
7270 If it is not specified, you will be asked.
7273 \begin_layout Description
7274 Origin sanda, 10 Jul 2009
7277 \begin_layout Subsection*
7278 LFUN_LABEL_COPY_AS_REF
7281 \begin_layout Description
7282 Action Copies the label at the cursor as a cross-reference to be pasted
7286 \begin_layout Description
7287 Syntax copy-label-as-reference <LABEL>
7290 \begin_layout Description
7291 Params <LABEL>: The label to copy (for multi-line math)
7294 \begin_layout Description
7295 Origin sts, 16 Nov 2008
7298 \begin_layout Subsection*
7299 LFUN_LABEL_INSERT_AS_REF
7302 \begin_layout Description
7303 Action Inserts the label (in ToC pane) as a cross-reference at the position
7307 \begin_layout Description
7308 Syntax label-insert-as-reference
7311 \begin_layout Description
7312 Origin vfr, 7 Apr 2009
7315 \begin_layout Subsection*
7319 \begin_layout Description
7320 Action Increases the zoom of the screen fonts.
7323 \begin_layout Description
7324 Syntax buffer-zoom-in [<ZOOM>]
7327 \begin_layout Description
7328 Params <ZOOM>: The zoom in %, the default is 20.
7331 \begin_layout Description
7332 Origin vfr, 30 Mar 2009
7335 \begin_layout Subsection*
7336 LFUN_BUFFER_ZOOM_OUT
7339 \begin_layout Description
7340 Action Decreases the zoom of the screen fonts.
7343 \begin_layout Description
7344 Syntax buffer-zoom-out [<ZOOM>]
7347 \begin_layout Description
7348 Params <ZOOM>: The zoom in %, the default is 20.
7351 \begin_layout Description
7352 Origin vfr, 30 Mar 2009
7355 \begin_layout Subsection*
7359 \begin_layout Description
7360 Action Copies the inset to the clipboard as a certain type.
7363 \begin_layout Description
7364 Notion Currently used only for InsetInfo where its content is copied as
7368 \begin_layout Description
7369 Syntax inset-copy-as
7372 \begin_layout Description
7373 Origin vfr, 18 Apr 2010
7376 \begin_layout Subsection*
7377 LFUN_ENVIRONMENT_SPLIT
7380 \begin_layout Description
7381 Action Splits the current environment with a Separator.
7384 \begin_layout Description
7385 Syntax environment-split
7388 \begin_layout Description
7389 Origin spitz, 23 Dec 2012