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
45 \use_package mathdots 0
46 \use_package mathtools 0
48 \use_package stackrel 0
49 \use_package stmaryrd 0
50 \use_package undertilde 0
52 \cite_engine_type numerical
56 \paperorientation portrait
70 \paragraph_separation indent
71 \paragraph_indentation default
72 \quotes_language english
75 \paperpagestyle default
76 \tracking_changes false
85 \begin_layout Section*
86 LFUNs documentation automatically generated 2013-02-05
89 \begin_layout Standard
93 \begin_layout Plain Layout
103 \begin_inset VSpace 1cm
109 \begin_layout Subsection*
113 \begin_layout Description
114 Action Adds an acute accent to the next character typed.
117 \begin_layout Description
121 \begin_layout Subsection*
125 \begin_layout Description
126 Action Adds a breve accent to the next character typed.
129 \begin_layout Description
133 \begin_layout Subsection*
137 \begin_layout Description
138 Action Adds a caron to the next character typed.
141 \begin_layout Description
145 \begin_layout Subsection*
149 \begin_layout Description
150 Action Adds a cedilla to the next character typed.
153 \begin_layout Description
154 Syntax accent-cedilla
157 \begin_layout Subsection*
161 \begin_layout Description
162 Action Adds a circle accent to the next character typed.
165 \begin_layout Description
169 \begin_layout Subsection*
170 LFUN_ACCENT_CIRCUMFLEX
173 \begin_layout Description
174 Action Adds a circumflex to the next character typed.
177 \begin_layout Description
178 Syntax accent-circumflex
181 \begin_layout Subsection*
185 \begin_layout Description
186 Action Adds a dot accent to the next character typed.
189 \begin_layout Description
193 \begin_layout Subsection*
197 \begin_layout Description
198 Action Adds a grave accent to the next character typed.
201 \begin_layout Description
205 \begin_layout Subsection*
206 LFUN_ACCENT_HUNGARIAN_UMLAUT
209 \begin_layout Description
210 Action Adds a Hungarian umlaut to the next character typed.
213 \begin_layout Description
217 \begin_layout Subsection*
221 \begin_layout Description
222 Action Adds a macron to the next character typed.
225 \begin_layout Description
229 \begin_layout Subsection*
233 \begin_layout Description
234 Action Adds an ogonek accent to the next character typed.
237 \begin_layout Description
241 \begin_layout Subsection*
245 \begin_layout Description
246 Action Adds a tie over the next two character typed.
249 \begin_layout Description
250 Notion The following char will finish the tie.
253 \begin_layout Description
257 \begin_layout Subsection*
261 \begin_layout Description
262 Action Adds a tilde over the next character typed.
265 \begin_layout Description
269 \begin_layout Subsection*
273 \begin_layout Description
274 Action Adds an umlaut over the next character typed.
277 \begin_layout Description
281 \begin_layout Subsection*
285 \begin_layout Description
286 Action Adds a bar under the next character typed.
289 \begin_layout Description
290 Syntax accent-underbar
293 \begin_layout Subsection*
297 \begin_layout Description
298 Action Adds a dot under the next character typed.
301 \begin_layout Description
302 Syntax accent-underdot
305 \begin_layout Subsection*
309 \begin_layout Description
310 Action Inserts a caption inset.
313 \begin_layout Description
314 Syntax caption-insert
317 \begin_layout Description
318 Origin Lgb, 18 Jul 2000
321 \begin_layout Subsection*
325 \begin_layout Description
326 Action Inserts the current date.
329 \begin_layout Description
330 Syntax date-insert [<ARG>]
333 \begin_layout Description
334 Params <ARG>: Format of date.
335 The default value (%x) can be set in Preferences->Date format.
336 For possible formats see manual page of strftime function.
339 \begin_layout Description
340 Origin jdblair, 31 Jan 2000
343 \begin_layout Subsection*
347 \begin_layout Description
348 Action Inserts a footnote inset.
351 \begin_layout Description
352 Syntax footnote-insert
355 \begin_layout Description
356 Origin Jug, 7 Mar 2000
359 \begin_layout Subsection*
363 \begin_layout Description
364 Action Inserts an ERT inset.
367 \begin_layout Description
371 \begin_layout Description
372 Origin Jug, 18 Feb 2000
375 \begin_layout Subsection*
379 \begin_layout Description
380 Action Inserts a float inset.
383 \begin_layout Description
384 Syntax float-insert <TYPE>
387 \begin_layout Description
388 Params <TYPE>: type of float depends on the used textclass.
389 Usually "algorithm", "table", "figure" parameters can be given.
392 \begin_layout Description
393 Origin Lgb, 27 Jun 2000
396 \begin_layout Subsection*
397 LFUN_FLOAT_WIDE_INSERT
400 \begin_layout Description
401 Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
404 \begin_layout Description
405 Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
408 \begin_layout Description
409 Syntax float-wide-insert <TYPE>
412 \begin_layout Description
413 Params <TYPE>: type of float depends on the used textclass.
414 Usually "algorithm", "table", "figure" parameters can be given.
417 \begin_layout Description
418 Origin Lgb, 31 Oct 2001
421 \begin_layout Subsection*
422 LFUN_FLOAT_LIST_INSERT
425 \begin_layout Description
426 Action Inserts the list of floats in the document.
429 \begin_layout Description
430 Syntax float-list-insert <TYPE>
433 \begin_layout Description
434 Params <TYPE>: type of float depends on the used textclass.
435 Usually "algorithm", "table", "figure" parameters can be given.
438 \begin_layout Description
439 Origin Lgb, 3 May 2001
442 \begin_layout Subsection*
446 \begin_layout Description
447 Action Inserts floats wrapped by the text around.
450 \begin_layout Description
451 Syntax wrap-insert <TYPE>
454 \begin_layout Description
455 Params <TYPE>: table|figure
458 \begin_layout Description
459 Origin Dekel, 7 Apr 2002
462 \begin_layout Subsection*
466 \begin_layout Description
467 Action Inserts an argument (short title) inset.
470 \begin_layout Description
471 Syntax argument-insert <argument nr>
474 \begin_layout Description
475 Params <argument nr>: see layout declarations
478 \begin_layout Description
479 Origin vermeer, 12 Aug 2002
482 \begin_layout Subsection*
486 \begin_layout Description
487 Action Inserts a new page.
490 \begin_layout Description
491 Syntax newpage-insert <ARG>
494 \begin_layout Description
495 Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
498 \begin_layout Description
499 Origin uwestoehr, 24 Nov 2007
502 \begin_layout Subsection*
503 LFUN_MARGINALNOTE_INSERT
506 \begin_layout Description
507 Action Inserts a marginal note.
510 \begin_layout Description
511 Syntax marginalnote-insert
514 \begin_layout Description
515 Origin Lgb, 26 Jun 2000
518 \begin_layout Subsection*
522 \begin_layout Description
523 Action Inserts a single unicode character.
526 \begin_layout Description
527 Syntax unicode-insert <CHAR>
530 \begin_layout Description
531 Params <CHAR>: The character to insert, given as its code point, in hexadecimal.
534 \begin_layout Description
535 Sample unicode-insert 0x0100
538 \begin_layout Description
539 Origin Lgb, 22 Oct 2006
542 \begin_layout Subsection*
546 \begin_layout Description
547 Action Inserts a new listings inset.
550 \begin_layout Description
551 Syntax listing-insert
554 \begin_layout Description
555 Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
558 \begin_layout Subsection*
562 \begin_layout Description
563 Action Inserts a new preview inset.
566 \begin_layout Description
567 Syntax preview-insert
570 \begin_layout Description
571 Origin vfr, 28 Mar 2010
574 \begin_layout Subsection*
578 \begin_layout Description
579 Action Insert a tab into a listings inset.
582 \begin_layout Description
583 Notion It also works on a selection.
586 \begin_layout Description
590 \begin_layout Description
591 Origin vfr, Sep 30 2008
594 \begin_layout Subsection*
598 \begin_layout Description
599 Action Delete a tab or up to an equivalent amount of spaces from a listings
603 \begin_layout Description
604 Notion It also works on a selection - it removes a tab or spaces from the
605 beginning of each line spanned by the selection.
606 This is useful if you want to indent/unindent multiple lines in one action.
609 \begin_layout Description
613 \begin_layout Description
614 Origin vfr, Sep 30 2008
617 \begin_layout Subsection*
621 \begin_layout Description
622 Action Inserts quotes according to the type and quote-language preference.
625 \begin_layout Description
626 Notion Currently English, Swedish, German, Polish, French, Danish quotes
630 \begin_layout Description
631 Syntax quote-insert [<TYPE>]
634 \begin_layout Description
635 Params <TYPE>: 'single' for single quotes, otherwise double quotes will
639 \begin_layout Subsection*
643 \begin_layout Description
644 Action Displays shortcuts, lyxrc, package and textclass availability and
645 menu information in a non-editable boxed InsetText.
648 \begin_layout Description
649 Notion Apart from lfun arguments you can use the following method:
650 \begin_inset Newline newline
654 input the type and argument of this inset, e.g.
655 "menu paste", in the work area.
656 \begin_inset Newline newline
660 select the text and run info-insert lfun.
663 \begin_layout Description
664 Syntax info-insert <TYPE> <ARG>
667 \begin_layout Description
668 Params <TYPE>: shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|buffer
669 \begin_inset Newline newline
672 <ARG>: argument for a given type.
673 Look into InsetInfo.h for detailed description.
674 \begin_inset Newline newline
677 shortcut[s]: name of lfun (e.g math-insert
680 \begin_inset Newline newline
683 lyxrc: name of rc_entry (e.g.
685 \begin_inset Newline newline
688 lyxinfo: "version" - used version of LyX
689 \begin_inset Newline newline
692 package: name of latex package (e.g.
694 \begin_inset Newline newline
697 textclass: name of textclass (e.g.
699 \begin_inset Newline newline
702 menu: name of lfun used in menu
703 \begin_inset Newline newline
706 icon: icon of lfun used in toolbar
707 \begin_inset Newline newline
710 buffer: "name"|"path"|"class"|"vcs-tree-revision"| "vcs-revision"|"vcs-a
711 uthor"|"vcs-date"|"vcs-time"
714 \begin_layout Description
715 Sample command-sequence info-insert buffer path; info-insert buffer name
718 \begin_layout Description
719 Origin bpeng, 7 Oct 2007
722 \begin_layout Subsection*
726 \begin_layout Description
727 Action Inserts branch inset.
730 \begin_layout Description
731 Syntax branch-insert <BRANCH-NAME>
734 \begin_layout Description
735 Origin vermeer, 17 Aug 2003
738 \begin_layout Subsection*
742 \begin_layout Description
743 Action Inserts Box inset.
746 \begin_layout Description
747 Syntax box-insert [<TYPE>]
750 \begin_layout Description
751 Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
752 \begin_inset Newline newline
755 Framed is the default one.
758 \begin_layout Description
759 Origin vermeer, 7 Oct 2003
762 \begin_layout Subsection*
766 \begin_layout Description
767 Action Inserts CharStyle, Custom inset or XML short element.
770 \begin_layout Description
771 Notion Look into the Customization manual for more information about these
773 \begin_inset Newline newline
776 To make this command enabled the layout file for the document class you're
777 using has to load the character styles.
778 There are a few contained in the Logical Markup module.
779 You can also of course create some yourself.
780 \begin_inset Newline newline
783 For dissolving the element see LFUN_INSET_DISSOLVE.
786 \begin_layout Description
787 Syntax flex-insert Name
790 \begin_layout Description
791 Params Name: This name must be defined either in your layout file or imported
793 The definition is InsetLayout Name or InsetLayout <Flex:Name>.
794 The Flex: prefix is optional.
797 \begin_layout Description
798 Sample flex-insert Code
801 \begin_layout Subsection*
805 \begin_layout Description
806 Action Inserts the given string (accordingly to the correct keymap).
809 \begin_layout Description
810 Notion Automatically replace the currently selected text.
811 Depends on lyxrc settings "auto_region_delete".
814 \begin_layout Description
815 Syntax self-insert <STRING>
818 \begin_layout Subsection*
822 \begin_layout Description
823 Action Inserts one of horizontal space insets.
826 \begin_layout Description
827 Syntax space-insert <NAME> [<LEN>]
830 \begin_layout Description
831 Params <NAME>: normal, protected, visible, thin, quad, qquad, enspace, enskip,
832 negthinspace, negmedspace, negthickspace, hfill, hfill*, dotfill, hrulefill,
834 \begin_inset Newline newline
837 Only in math mode: med and thick.
838 \begin_inset Newline newline
841 <LEN>: length for custom spaces (hspace, hspace* for protected)
844 \begin_layout Description
845 Origin JSpitzm, 20 May 2003, Mar 17 2008
848 \begin_layout Subsection*
849 LFUN_HYPERLINK_INSERT
852 \begin_layout Description
853 Action Inserts hyperlinks into the document (clickable in pdf output).
856 \begin_layout Description
857 Notion Hyperlink target can be set via selection + hyperlink-insert function.
860 \begin_layout Description
861 Syntax href-insert [<TARGET>]
864 \begin_layout Description
865 Origin CFO-G, 21 Nov 1997
868 \begin_layout Subsection*
869 LFUN_SPECIALCHAR_INSERT
872 \begin_layout Description
873 Action Inserts various characters into the document.
876 \begin_layout Description
877 Syntax specialchar-insert <CHAR>
880 \begin_layout Description
881 Params <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots, end-of-sen
882 tence, menu-separator.
885 \begin_layout Description
886 Origin JSpitzm, 6 Dec 2007
889 \begin_layout Subsection*
893 \begin_layout Description
894 Action Inserts a subscript or superscript inset.
897 \begin_layout Description
898 Syntax script-insert <TYPE>
901 \begin_layout Description
902 Params <TYPE>: subscript|superscript
905 \begin_layout Description
906 Origin Georg, 23 Nov 2010
909 \begin_layout Subsection*
913 \begin_layout Description
914 Action Start (or remove) Appendix on the given cursor position.
917 \begin_layout Description
921 \begin_layout Description
922 Origin ettrich, 5 May 1998
925 \begin_layout Subsection*
929 \begin_layout Description
930 Action Inserts Index entry.
933 \begin_layout Description
934 Notion It automatically takes the word on the cursor position.
937 \begin_layout Description
938 Syntax index-insert [<TYPE:Name>]
941 \begin_layout Description
942 Params <TYPE:Name>: name of the index, if multiple indices are defined.
943 With an empty argument, the default index is selected.
946 \begin_layout Description
947 Origin leeming, 3 Aug 2000
950 \begin_layout Subsection*
954 \begin_layout Description
955 Action Inserts list of Index entries on a new page.
958 \begin_layout Description
959 Syntax index-print [<TYPE:Name>]
962 \begin_layout Description
963 Params <TYPE:Name>: name of the index, if multiple indices are defined.
964 With an empty argument, the default index is selected.
967 \begin_layout Description
968 Origin Lgb, 27 Feb 1997
971 \begin_layout Subsection*
975 \begin_layout Description
976 Action Inserts an IPA inset.
979 \begin_layout Description
983 \begin_layout Description
984 Origin spitz, 05 Mar 2012
987 \begin_layout Subsection*
991 \begin_layout Description
992 Action Only active in IPA inset.
995 \begin_layout Description
996 Notion Dummy function which is only active in a IPA inset.
997 It's used to toggle the IPA toolbar if the cursor moves into an IPA inset.
1000 \begin_layout Description
1004 \begin_layout Description
1005 Origin spitz, 20 May 2012
1008 \begin_layout Subsection*
1009 LFUN_IPAMACRO_INSERT
1012 \begin_layout Description
1013 Action Inserts special IPA macros into the document.
1016 \begin_layout Description
1017 Syntax ipamacro-insert <CHAR>
1020 \begin_layout Description
1021 Params <CHAR>: tone-falling, tone-rising, tone-high-rising, tone-low-rising,
1022 tone-high-rising-falling, deco bottomtiebar, deco toptiebar.
1025 \begin_layout Description
1026 Origin JSpitzm, 22 Aug 2012
1029 \begin_layout Subsection*
1033 \begin_layout Description
1034 Action Inserts Nomenclature entry.
1037 \begin_layout Description
1038 Notion It automatically takes the word on the cursor position if no symbol
1042 \begin_layout Description
1043 Syntax nomencl-insert [<SYMBOL>]
1046 \begin_layout Description
1047 Origin Ugras, 4 Nov 2006
1050 \begin_layout Subsection*
1051 LFUN_NOMENCLATURE_PRINT
1054 \begin_layout Description
1055 Action Inserts list of Nomenclature entries.
1058 \begin_layout Description
1059 Syntax nomenclature-print
1062 \begin_layout Description
1063 Origin Ugras, 4 Nov 2006
1066 \begin_layout Subsection*
1070 \begin_layout Description
1071 Action Inserts Note on the current cursor position, move selection inside
1075 \begin_layout Description
1076 Syntax note-insert [<TYPE>]
1079 \begin_layout Description
1080 Params <TYPE>: <Note|Greyedout|Comment> default: Note
1083 \begin_layout Subsection*
1087 \begin_layout Description
1088 Action Moves the cursor to the beginning of next Note inset.
1091 \begin_layout Description
1095 \begin_layout Subsection*
1099 \begin_layout Description
1100 Action Inserts phantom on the current cursor position, move selection inside
1104 \begin_layout Description
1105 Syntax phantom-insert [<TYPE>]
1108 \begin_layout Description
1109 Params <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
1112 \begin_layout Description
1113 Origin uwestoehr, 30 Jan 2009
1116 \begin_layout Subsection*
1120 \begin_layout Description
1121 Action Inserts a line break or new line.
1124 \begin_layout Description
1125 Syntax newline-insert [<ARG>]
1128 \begin_layout Description
1129 Params <ARG>: <newline|linebreak> default: newline
1132 \begin_layout Description
1133 Origin JSpitzm, 25 Mar 2008
1136 \begin_layout Subsection*
1140 \begin_layout Description
1141 Action Clears the selection.
1142 If no text is selected call LFUN_FINISHED_FORWARD.
1143 Inside math mode jumps out of the math inset.
1146 \begin_layout Description
1150 \begin_layout Description
1151 Origin Lgb, 17 May 2001
1154 \begin_layout Subsection*
1158 \begin_layout Description
1159 Action Moves the cursor one line in downward direction.
1162 \begin_layout Description
1166 \begin_layout Subsection*
1170 \begin_layout Description
1171 Action Moves the cursor one line in upward direction.
1174 \begin_layout Description
1178 \begin_layout Subsection*
1182 \begin_layout Description
1183 Action Moves the cursor one line in downward direction adding the current
1184 position to the selection.
1187 \begin_layout Description
1191 \begin_layout Subsection*
1195 \begin_layout Description
1196 Action Moves the cursor one line in upward direction adding the current
1197 position to the selection.
1200 \begin_layout Description
1204 \begin_layout Subsection*
1208 \begin_layout Description
1209 Action Moves the cursor one page in downward direction.
1212 \begin_layout Description
1216 \begin_layout Subsection*
1220 \begin_layout Description
1221 Action Moves the cursor one page in upward direction.
1224 \begin_layout Description
1228 \begin_layout Subsection*
1229 LFUN_SCREEN_DOWN_SELECT
1232 \begin_layout Description
1233 Action Moves the cursor one screen in downward direction adding the current
1234 position to the selection.
1237 \begin_layout Description
1238 Syntax screen-down-select
1241 \begin_layout Subsection*
1242 LFUN_SCREEN_UP_SELECT
1245 \begin_layout Description
1246 Action Moves the cursor one page in upward direction adding the current
1247 position to the selection.
1250 \begin_layout Description
1251 Syntax screen-up-select
1254 \begin_layout Subsection*
1258 \begin_layout Description
1259 Action Scroll the buffer view.
1262 \begin_layout Description
1263 Notion Only scrolls the screen up or down; does not move the cursor.
1266 \begin_layout Description
1267 Syntax scroll <TYPE> <QUANTITY>
1270 \begin_layout Description
1271 Params <TYPE>: line|page
1272 \begin_inset Newline newline
1275 <QUANTITY>: up|down|<number>
1278 \begin_layout Description
1279 Origin Abdel, Dec 27 2007
1282 \begin_layout Subsection*
1283 LFUN_SCREEN_RECENTER
1286 \begin_layout Description
1287 Action Recenters the screen on the current cursor position.
1290 \begin_layout Description
1291 Syntax screen-recenter
1294 \begin_layout Subsection*
1295 LFUN_SCREEN_SHOW_CURSOR
1298 \begin_layout Description
1299 Action Repositions the screen such that the cursor is visible.
1302 \begin_layout Description
1303 Syntax screen-show-cursor
1306 \begin_layout Description
1307 Origin vfr, 25 Mar 2009
1310 \begin_layout Subsection*
1314 \begin_layout Description
1315 Action Moves the cursor one position logically backwards.
1318 \begin_layout Description
1319 Notion This is not the action which should be bound to the arrow keys, because
1320 backwards may be left or right, depending on the language.
1321 The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions,
1322 which in turn may employ this one.
1325 \begin_layout Description
1326 Syntax char-backward
1329 \begin_layout Subsection*
1330 LFUN_CHAR_BACKWARD_SELECT
1333 \begin_layout Description
1334 Action Moves the cursor one position logically backwards, adding traversed
1335 position to the selection.
1338 \begin_layout Description
1339 Notion See also LFUN_CHAR_BACKWARD.
1342 \begin_layout Description
1343 Syntax char-backward-select
1346 \begin_layout Subsection*
1347 LFUN_CHAR_DELETE_BACKWARD
1350 \begin_layout Description
1351 Action Deletes one character in the backward direction (usually the "BackSpace"
1355 \begin_layout Description
1356 Syntax char-delete-backward
1359 \begin_layout Subsection*
1360 LFUN_CHAR_DELETE_FORWARD
1363 \begin_layout Description
1364 Action Deletes one character in the backward direction (usually the "Delete"
1368 \begin_layout Description
1369 Syntax char-delete-forward
1372 \begin_layout Subsection*
1376 \begin_layout Description
1377 Action Moves the cursor one position logically forward.
1380 \begin_layout Description
1381 Notion This is not the action which should be bound to the arrow keys, because
1382 forward may be left or right, depending on the language.
1383 The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions,
1384 which in turn may employ this one.
1387 \begin_layout Description
1391 \begin_layout Subsection*
1392 LFUN_CHAR_FORWARD_SELECT
1395 \begin_layout Description
1396 Action Moves the cursor one position logically forward, adding traversed
1397 position to the selection.
1400 \begin_layout Description
1401 Notion See also LFUN_CHAR_FORWARD.
1404 \begin_layout Description
1405 Syntax char-forward-select
1408 \begin_layout Subsection*
1412 \begin_layout Description
1413 Action Moves the cursor one position "to the left".
1416 \begin_layout Description
1417 Notion This is the action which should be taken when the "left" key is pressed.
1418 Generally, it moves the cursor one position to the left.
1419 However, in Bidi text this become slightly more complicated, and there
1420 are different modes of cursor movement.
1421 In "visual mode", this moves left, plain and simple.
1422 In "logical mode", movement is logically forward in RTL paragraphs, and
1423 logically backwards in LTR paragraphs.
1426 \begin_layout Description
1430 \begin_layout Subsection*
1431 LFUN_CHAR_LEFT_SELECT
1434 \begin_layout Description
1435 Action Moves the cursor one position "to the left", adding traversed position
1439 \begin_layout Description
1440 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1443 \begin_layout Description
1444 Syntax char-left-select
1447 \begin_layout Subsection*
1451 \begin_layout Description
1452 Action Moves the cursor one position "to the right".
1455 \begin_layout Description
1456 Notion This is the action which should be taken when the "right" key is
1458 Generally, it moves the cursor one position to the right.
1459 However, in Bidi text this become slightly more complicated, and there
1460 are different modes of cursor movement.
1461 In "visual mode", this moves right, plain and simple.
1462 In "logical mode", movement is logically forward in LTR paragraphs, and
1463 logically backwards in RTL paragraphs.
1466 \begin_layout Description
1470 \begin_layout Subsection*
1471 LFUN_CHAR_RIGHT_SELECT
1474 \begin_layout Description
1475 Action Moves the cursor one position "to the right", adding traversed position
1479 \begin_layout Description
1480 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1483 \begin_layout Description
1484 Syntax char-right-select
1487 \begin_layout Subsection*
1491 \begin_layout Description
1492 Action Moves the cursor to the logically previous beginning of a word.
1495 \begin_layout Description
1496 Notion This is not the action which should be bound to the arrow keys, because
1497 backwards may be left or right, depending on the language.
1498 The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
1499 which in turn may employ this one.
1502 \begin_layout Description
1503 Syntax word-backward
1506 \begin_layout Subsection*
1507 LFUN_WORD_BACKWARD_SELECT
1510 \begin_layout Description
1511 Action Moves the cursor to the logically previous beginning of a word, adding
1512 the logically traversed text to the selection.
1515 \begin_layout Description
1516 Notion See also LFUN_WORD_BACKWARD.
1519 \begin_layout Description
1520 Syntax word-backward-select
1523 \begin_layout Subsection*
1524 LFUN_WORD_DELETE_BACKWARD
1527 \begin_layout Description
1528 Action Deletes characters to the beginning of the word (usually the "C+BackSpace
1532 \begin_layout Description
1533 Syntax word-delete-backward
1536 \begin_layout Subsection*
1537 LFUN_WORD_DELETE_FORWARD
1540 \begin_layout Description
1541 Action Deletes characters to the end of the word (usually the "C+Delete"
1545 \begin_layout Description
1546 Syntax word-delete-forward
1549 \begin_layout Subsection*
1550 LFUN_WORD_FIND_FORWARD
1553 \begin_layout Description
1554 Action Search for a given string in forward direction.
1557 \begin_layout Description
1558 Notion Case sensitive, match words.
1559 If no argument given, last search repeated.
1562 \begin_layout Description
1563 Syntax word-find-forward [<STRING>]
1566 \begin_layout Description
1567 Origin Etienne, 16 Feb 1998
1570 \begin_layout Subsection*
1571 LFUN_WORD_FIND_BACKWARD
1574 \begin_layout Description
1575 Action Search for a given string in backward direction.
1578 \begin_layout Description
1579 Notion Case sensitive, match words.
1580 If no argument given, last search repeated.
1583 \begin_layout Description
1584 Syntax word-find-backward [<STRING>]
1587 \begin_layout Description
1588 Origin Etienne, 20 Feb 1998
1591 \begin_layout Subsection*
1595 \begin_layout Description
1596 Action Search for next occurrence of a string.
1599 \begin_layout Description
1600 Syntax word-find [<DATA>]
1603 \begin_layout Description
1604 Params <DATA>: data encoded from Find dialog (see lyx::find2string()).
1605 If no parameter is given, search with last find-dialog data is used for
1610 \begin_layout Description
1611 Origin Andre, Jan 7 2004
1614 \begin_layout Subsection*
1618 \begin_layout Description
1619 Action Replace a string in the document.
1622 \begin_layout Description
1623 Syntax word-replace [<DATA>]
1626 \begin_layout Description
1627 Params <DATA>: data is of the form "<replace>
1628 \begin_inset Newline newline
1632 \begin_inset Newline newline
1635 <casesensitive> <matchword> <all> <forward> <findnext>"
1638 \begin_layout Description
1639 Origin Andre, Jan 7 2004
1642 \begin_layout Subsection*
1646 \begin_layout Description
1647 Action Search for next occurrence of a pattern.
1650 \begin_layout Description
1651 Syntax word-findadv [<DATA>]
1654 \begin_layout Description
1655 Params <DATA>: data encoded from FindAdv dialog (see lyx::findadv2string()).
1656 If no parameter is given, search with last find-dialog data is used for
1661 \begin_layout Description
1662 Origin Tommaso, Nov 15 2007
1665 \begin_layout Subsection*
1669 \begin_layout Description
1670 Action Moves the cursor to the logically next beginning of a word.
1673 \begin_layout Description
1674 Notion This is not the action which should be bound to the arrow keys, because
1675 forward may be left or right, depending on the language.
1676 The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
1677 which in turn may employ this one.
1680 \begin_layout Description
1684 \begin_layout Subsection*
1685 LFUN_WORD_FORWARD_SELECT
1688 \begin_layout Description
1689 Action Moves the cursor to the logically next beginning of a word, adding
1690 the logically traversed text to the selection.
1693 \begin_layout Description
1694 Notion See also LFUN_WORD_FORWARD.
1697 \begin_layout Description
1698 Syntax word-forward-select
1701 \begin_layout Subsection*
1705 \begin_layout Description
1706 Action Moves the cursor to the next beginning of a word "on the left".
1709 \begin_layout Description
1710 Notion This is the action which should be taken when the (e.g., ctrl-) "left"
1712 Generally, it moves the cursor to the next beginning of a word on the left.
1713 However, in Bidi text this become slightly more complicated, and there
1714 are different modes of cursor movement.
1715 In "visual mode", this moves left, plain and simple.
1716 In "logical mode", movement is logically forward in RTL paragraphs, and
1717 logically backwards in LTR paragraphs.
1720 \begin_layout Description
1724 \begin_layout Description
1725 Origin dov, 28 Oct 2007
1728 \begin_layout Subsection*
1729 LFUN_WORD_LEFT_SELECT
1732 \begin_layout Description
1733 Action Moves the cursor to the next beginning of a word "on the left", adding
1734 *logically* traversed text to the selection.
1737 \begin_layout Description
1738 Notion See also LFUN_WORD_LEFT for exact details of the movement.
1741 \begin_layout Description
1742 Syntax word-left-select
1745 \begin_layout Description
1746 Origin dov, 28 Oct 2007
1749 \begin_layout Subsection*
1753 \begin_layout Description
1754 Action Moves the cursor to the next beginning of a word "on the right".
1757 \begin_layout Description
1758 Notion This is the action which should be taken when the (e.g., ctrl-) "right"
1760 Generally, it moves the cursor to the next beginning of a word on the right.
1761 However, in Bidi text this become slightly more complicated, and there
1762 are different modes of cursor movement.
1763 In "visual mode", this moves right, plain and simple.
1764 In "logical mode", movement is logically forward in LTR paragraphs, and
1765 logically backwards in RTL paragraphs.
1768 \begin_layout Description
1772 \begin_layout Description
1773 Origin dov, 28 Oct 2007
1776 \begin_layout Subsection*
1777 LFUN_WORD_RIGHT_SELECT
1780 \begin_layout Description
1781 Action Moves the cursor to the next beginning of a word "on the right",
1782 adding *logically* traversed text to the selection.
1785 \begin_layout Description
1786 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
1789 \begin_layout Description
1790 Syntax word-right-select
1793 \begin_layout Description
1794 Origin dov, 28 Oct 2007
1797 \begin_layout Subsection*
1801 \begin_layout Description
1802 Action Puts the word where the cursor stands into the selection.
1805 \begin_layout Description
1809 \begin_layout Description
1810 Origin Andre, 11 Sep 2002
1813 \begin_layout Subsection*
1814 LFUN_WORD_CAPITALIZE
1817 \begin_layout Description
1818 Action Capitalizes the words in the selection (i.e.
1819 the first letters) or the letter on the cursor position.
1822 \begin_layout Description
1823 Syntax word-capitalize
1826 \begin_layout Subsection*
1830 \begin_layout Description
1831 Action Change the words in the selection or from the cursor position to
1832 the end of word to the upper case.
1835 \begin_layout Description
1839 \begin_layout Subsection*
1843 \begin_layout Description
1844 Action Change the words in the selection or from the cursor position to
1845 the end of word to the lower case.
1848 \begin_layout Description
1852 \begin_layout Subsection*
1856 \begin_layout Description
1857 Action Add the word under the cursor to the respective spell checker dictionary.
1860 \begin_layout Description
1861 Syntax spelling-add [<STRING>] [<LANG>]
1864 \begin_layout Description
1865 Params <WORD>: word to add <LANG>: language name (see file languages)
1868 \begin_layout Description
1869 Origin JSpitzm, 18 Jan 2010
1872 \begin_layout Subsection*
1873 LFUN_SPELLING_IGNORE
1876 \begin_layout Description
1877 Action Let the spell checker ignore the word under the cursor in the current
1878 session for the given language.
1881 \begin_layout Description
1882 Syntax spelling-ignore [<WORD>] [<LANG>]
1885 \begin_layout Description
1886 Params <WORD>: word to ignore <LANG>: language name (see file languages)
1889 \begin_layout Description
1890 Origin JSpitzm, 18 Jan 2010
1893 \begin_layout Subsection*
1894 LFUN_SPELLING_REMOVE
1897 \begin_layout Description
1898 Action Remove the word under the cursor from the respective spell checker
1902 \begin_layout Description
1903 Syntax spelling-remove [<STRING>] [<LANG>]
1906 \begin_layout Description
1907 Params <WORD>: word to remove <LANG>: language name (see file languages)
1910 \begin_layout Description
1911 Origin SWitt, 28 July 2010
1914 \begin_layout Subsection*
1915 LFUN_THESAURUS_ENTRY
1918 \begin_layout Description
1919 Action Look up thesaurus entries with respect to the word under the cursor.
1922 \begin_layout Description
1923 Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
1926 \begin_layout Description
1927 Params <STRING>: word to look up <LANG>: language (see file languages)
1930 \begin_layout Description
1931 Origin Levon, 20 Jul 2001
1934 \begin_layout Subsection*
1938 \begin_layout Description
1939 Action Move the cursor to the beginning of the document.
1942 \begin_layout Description
1946 \begin_layout Subsection*
1947 LFUN_BUFFER_BEGIN_SELECT
1950 \begin_layout Description
1951 Action Move the cursor to the beginning of the document adding the traversed
1952 text to the selection.
1955 \begin_layout Description
1956 Syntax buffer-begin-select
1959 \begin_layout Subsection*
1963 \begin_layout Description
1964 Action Move the cursor to the end of the document.
1967 \begin_layout Description
1971 \begin_layout Subsection*
1972 LFUN_BUFFER_END_SELECT
1975 \begin_layout Description
1976 Action Move the cursor to the end of the document adding the traversed text
1980 \begin_layout Description
1981 Syntax buffer-end-select
1984 \begin_layout Subsection*
1988 \begin_layout Description
1989 Action Move the cursor to the beginning of the current inset if it is not
1990 already there, or at the beginning of the enclosing inset otherwise
1993 \begin_layout Description
1997 \begin_layout Description
1998 Origin lasgouttes, 16 Mar 2009
2001 \begin_layout Subsection*
2002 LFUN_INSET_BEGIN_SELECT
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 (adding
2008 the traversed text to the selection).
2011 \begin_layout Description
2012 Syntax inset-begin-select
2015 \begin_layout Description
2016 Origin lasgouttes, 16 Mar 2009
2019 \begin_layout Subsection*
2023 \begin_layout Description
2024 Action Move the cursor to the end of the current inset if it is not already
2025 there, or at the end of the enclosing inset otherwise
2028 \begin_layout Description
2032 \begin_layout Description
2033 Origin lasgouttes, 16 Mar 2009
2036 \begin_layout Subsection*
2037 LFUN_INSET_END_SELECT
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 (adding the traversed
2043 text to the selection).
2046 \begin_layout Description
2047 Syntax inset-end-select
2050 \begin_layout Description
2051 Origin lasgouttes, 16 Mar 2009
2054 \begin_layout Subsection*
2055 LFUN_INSET_SELECT_ALL
2058 \begin_layout Description
2059 Action Selects all contents of an inset.
2062 \begin_layout Description
2063 Syntax inset-select-all
2066 \begin_layout Description
2067 Origin vfr, 22 Aug 2009
2070 \begin_layout Subsection*
2074 \begin_layout Description
2075 Action Selects the whole section.
2078 \begin_layout Description
2079 Notion The cursor should be in a section heading before calling this lfun.
2082 \begin_layout Description
2083 Syntax section-select
2086 \begin_layout Description
2087 Origin vfr, 05 May 2009
2090 \begin_layout Subsection*
2094 \begin_layout Description
2095 Action Move the cursor to the beginning of the (screen) line.
2098 \begin_layout Description
2102 \begin_layout Subsection*
2103 LFUN_LINE_BEGIN_SELECT
2106 \begin_layout Description
2107 Action Move the cursor to the beginning of the (screen) line adding the
2108 traversed text to the selection.
2111 \begin_layout Description
2112 Syntax line-begin-select
2115 \begin_layout Subsection*
2119 \begin_layout Description
2120 Action Move the cursor to the end of the (screen) line.
2123 \begin_layout Description
2127 \begin_layout Subsection*
2128 LFUN_LINE_END_SELECT
2131 \begin_layout Description
2132 Action Move the cursor to the end of the (screen) line adding the traversed
2133 text to the selection.
2136 \begin_layout Description
2137 Syntax line-end-select
2140 \begin_layout Subsection*
2144 \begin_layout Description
2145 Action Deletes the letters to the end of the (screen) line or deletes the
2149 \begin_layout Description
2150 Syntax line-delete-forward
2153 \begin_layout Subsection*
2157 \begin_layout Description
2158 Action Copies the current selection to the clipboard.
2161 \begin_layout Description
2165 \begin_layout Subsection*
2169 \begin_layout Description
2170 Action Cuts to the clipboard.
2173 \begin_layout Description
2177 \begin_layout Subsection*
2181 \begin_layout Description
2182 Action Pastes material (text or picture) from the active clipboard.
2185 \begin_layout Description
2186 Syntax paste [<TYPE>|<NUM>]
2189 \begin_layout Description
2190 Params <TYPE>: emf|pdf|png|jpeg|linkback|wmf
2191 \begin_inset Newline newline
2194 <NUM>: number of the selection in the internal clipboard stack to be pasted.
2197 \begin_layout Subsection*
2198 LFUN_CLIPBOARD_PASTE
2201 \begin_layout Description
2202 Action Pastes text from the active clipboard.
2205 \begin_layout Description
2206 Syntax clipboard-paste [<ARG>]
2209 \begin_layout Description
2210 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
2214 \begin_layout Description
2215 Origin Georg, 10 Jul 2006
2218 \begin_layout Subsection*
2219 LFUN_PRIMARY_SELECTION_PASTE
2222 \begin_layout Description
2223 Action Pastes the currently selected text.
2226 \begin_layout Description
2227 Notion Primary selection mechanism is linux-only thing.
2230 \begin_layout Description
2231 Syntax primary-selection-paste [<ARG>]
2234 \begin_layout Description
2235 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
2239 \begin_layout Subsection*
2240 LFUN_SELECTION_PASTE
2243 \begin_layout Description
2244 Action Pastes the internal selection text in permanent selection.
2247 \begin_layout Description
2248 Notion Created in order to have middle mouse button pasting correct (bound
2249 to command-alternatives selection-paste ; primary-selection-paste paragraph).
2252 \begin_layout Description
2253 Syntax selection-paste
2256 \begin_layout Description
2257 Origin lasgouttes, 14 Jan 2009
2260 \begin_layout Subsection*
2261 LFUN_CLIPBOARD_PASTE_SIMPLE
2264 \begin_layout Description
2265 Action Pastes simple unformatted text from the active clipboard.
2268 \begin_layout Description
2269 Syntax clipboard-paste-simple [<ARG>]
2272 \begin_layout Description
2273 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
2277 \begin_layout Subsection*
2281 \begin_layout Description
2282 Action Undoes the last edit.
2285 \begin_layout Description
2289 \begin_layout Subsection*
2293 \begin_layout Description
2294 Action Redoes the last thing undone.
2297 \begin_layout Description
2301 \begin_layout Subsection*
2305 \begin_layout Description
2306 Action Repeat the given command.
2309 \begin_layout Description
2310 Syntax repeat <COUNT> <LFUN-COMMAND>
2313 \begin_layout Description
2314 Origin Andre, 27 Oct 2003
2317 \begin_layout Subsection*
2318 LFUN_CHARS_TRANSPOSE
2321 \begin_layout Description
2322 Action Transposes the character at the cursor with the one before it.
2325 \begin_layout Description
2326 Syntax chars-transpose
2329 \begin_layout Description
2330 Origin Lgb, 25 Apr 2001
2333 \begin_layout Subsection*
2334 LFUN_DEPTH_DECREMENT
2337 \begin_layout Description
2338 Action Decrease the nesting depth of the (selected) paragraph(s) inside
2342 \begin_layout Description
2343 Syntax depth-decrement
2346 \begin_layout Subsection*
2347 LFUN_DEPTH_INCREMENT
2350 \begin_layout Description
2351 Action Increase the nesting depth of the (selected) paragraph(s) inside
2355 \begin_layout Description
2356 Syntax depth-increment
2359 \begin_layout Subsection*
2363 \begin_layout Description
2364 Action Toggles the bold font (selection-wise) using mathbf in math.
2367 \begin_layout Description
2371 \begin_layout Subsection*
2372 LFUN_FONT_BOLDSYMBOL
2375 \begin_layout Description
2376 Action Toggles the bold font (selection-wise) using boldsymbol in math.
2379 \begin_layout Description
2380 Syntax font-boldsymbol
2383 \begin_layout Subsection*
2384 LFUN_FONT_TYPEWRITER
2387 \begin_layout Description
2388 Action Toggles the typewriter family font (selection-wise).
2391 \begin_layout Description
2392 Syntax font-typewriter
2395 \begin_layout Subsection*
2399 \begin_layout Description
2400 Action Toggles underline in the font (selection-wise).
2403 \begin_layout Description
2404 Syntax font-underline
2407 \begin_layout Subsection*
2411 \begin_layout Description
2412 Action Toggles double underline in the font (selection-wise).
2415 \begin_layout Description
2416 Syntax font-underunderline
2419 \begin_layout Description
2420 Origin sanda, 5 May 2009
2423 \begin_layout Subsection*
2427 \begin_layout Description
2428 Action Toggles wavy underline in the font (selection-wise).
2431 \begin_layout Description
2432 Syntax font-underwave
2435 \begin_layout Description
2436 Origin sanda, 5 May 2009
2439 \begin_layout Subsection*
2443 \begin_layout Description
2444 Action Toggles strikeout (strike-through) in the font (selection-wise).
2447 \begin_layout Description
2448 Syntax font-strikeout
2451 \begin_layout Description
2452 Origin sanda, 3 May 2009
2455 \begin_layout Subsection*
2459 \begin_layout Description
2460 Action Toggles the emphasis font style (selection-wise).
2463 \begin_layout Description
2467 \begin_layout Subsection*
2471 \begin_layout Description
2472 Action Toggles Noun text style font (selection-wise).
2475 \begin_layout Description
2479 \begin_layout Subsection*
2483 \begin_layout Description
2484 Action Toggles Roman family font (selection-wise).
2487 \begin_layout Description
2491 \begin_layout Subsection*
2495 \begin_layout Description
2496 Action Toggles Sans Serif family font (selection-wise).
2499 \begin_layout Description
2503 \begin_layout Subsection*
2507 \begin_layout Description
2508 Action Toggles Fraktur family font (math-mode, selection-wise).
2511 \begin_layout Description
2515 \begin_layout Description
2516 Origin vermeer, 10 Jan 2002
2519 \begin_layout Subsection*
2523 \begin_layout Description
2524 Action Toggles Italics font shape (math-mode, selection-wise).
2527 \begin_layout Description
2531 \begin_layout Description
2532 Origin vermeer, 10 Jan 2002
2535 \begin_layout Subsection*
2539 \begin_layout Description
2540 Action Reverts the settings of the font to the default values (selection-wise).
2543 \begin_layout Description
2547 \begin_layout Subsection*
2551 \begin_layout Description
2552 Action Sets font size according to lyx format string.
2555 \begin_layout Description
2556 Syntax font-size <SIZE>
2559 \begin_layout Description
2560 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
2561 \begin_inset Newline newline
2564 largest|huge|giant|increase|decrease|default
2567 \begin_layout Subsection*
2568 LFUN_TEXTSTYLE_APPLY
2571 \begin_layout Description
2572 Action Toggle user-defined (=last-time used) text style.
2575 \begin_layout Description
2576 Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically
2577 triggered when using Text Style dialog.
2580 \begin_layout Description
2581 Syntax textstyle-apply
2584 \begin_layout Description
2585 Origin leeming, 12 Mar 2003
2588 \begin_layout Subsection*
2589 LFUN_TEXTSTYLE_UPDATE
2592 \begin_layout Description
2593 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APP
2597 \begin_layout Description
2598 Syntax textstyle-update <FONT_INFO>
2601 \begin_layout Description
2602 Params <FONT_INFO>: specifies font atributes, e.g.
2603 family, series, shape, size, emph, noun, underbar, number, color, language,
2605 \begin_inset Newline newline
2608 Use lyx -dbg action for exact syntax of text-style dialog parameters.
2611 \begin_layout Description
2612 Origin leeming, 12 Mar 2003
2615 \begin_layout Subsection*
2616 LFUN_SCREEN_FONT_UPDATE
2619 \begin_layout Description
2620 Action Update fonts and its metrics.
2623 \begin_layout Description
2624 Notion Automatically called after zoom, dpi, font names, or norm change.
2627 \begin_layout Description
2628 Syntax screen-font-update
2631 \begin_layout Description
2632 Origin ARRae, 13 Aug 2000
2635 \begin_layout Subsection*
2639 \begin_layout Description
2640 Action Returns the info about the current font.
2643 \begin_layout Description
2647 \begin_layout Subsection*
2648 LFUN_CITATION_INSERT
2651 \begin_layout Description
2652 Action Inserts citation from loaded citation database.
2655 \begin_layout Description
2656 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
2659 \begin_layout Description
2660 Params <KEY>: Citation (shortcut listed in available citations).
2661 \begin_inset Newline newline
2664 <TEXT_BEFORE>: text which should appear before citation.
2667 \begin_layout Description
2668 Origin AAS, 97-02-23
2671 \begin_layout Subsection*
2672 LFUN_BIBTEX_DATABASE_ADD
2675 \begin_layout Description
2676 Action Adds database, which will be used for bibtex citations.
2679 \begin_layout Description
2680 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX
2681 bibliography) found from the cursor position.
2684 \begin_layout Description
2685 Syntax bibtex-database-add <DATABASE-NAME>
2688 \begin_layout Description
2689 Origin Ale, 30 May 1997
2692 \begin_layout Subsection*
2693 LFUN_BIBTEX_DATABASE_DEL
2696 \begin_layout Description
2697 Action Adds database, which will be used for bibtex citations.
2700 \begin_layout Description
2701 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTe
2702 X bibliography) found from the cursor position.
2705 \begin_layout Description
2706 Syntax bibtex-database-del <DATABASE-NAME>
2709 \begin_layout Description
2710 Origin Ale, 30 May 1997
2713 \begin_layout Subsection*
2717 \begin_layout Description
2718 Action Sets the layout (that is, environment) for the current paragraph.
2721 \begin_layout Description
2722 Syntax layout <LAYOUT>
2725 \begin_layout Description
2726 Params <LAYOUT>: the layout to use
2729 \begin_layout Subsection*
2730 LFUN_LAYOUT_PARAGRAPH
2733 \begin_layout Description
2734 Action Launches the paragraph settings dialog.
2737 \begin_layout Description
2738 Syntax layout-paragraph
2741 \begin_layout Subsection*
2745 \begin_layout Description
2746 Action Launches the tabular settings dialog.
2749 \begin_layout Description
2750 Syntax layout-tabular
2753 \begin_layout Description
2754 Origin Jug, 31 Jul 2000
2757 \begin_layout Subsection*
2758 LFUN_DROP_LAYOUTS_CHOICE
2761 \begin_layout Description
2762 Action Displays list of layout choices.
2765 \begin_layout Description
2766 Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox
2767 allowing for choice of layout.
2770 \begin_layout Description
2771 Syntax drop-layouts-choice
2774 \begin_layout Subsection*
2775 LFUN_LAYOUT_MODULES_CLEAR
2778 \begin_layout Description
2779 Action Clears the module list.
2782 \begin_layout Description
2783 Notion Clears the list of included modules for the current buffer.
2786 \begin_layout Description
2787 Syntax layout-modules-clear
2790 \begin_layout Description
2791 Origin rgh, 25 August 2007
2794 \begin_layout Subsection*
2795 LFUN_LAYOUT_MODULE_ADD
2798 \begin_layout Description
2799 Action Adds a module.
2802 \begin_layout Description
2803 Notion Adds a module to the list of included modules for the current buffer.
2806 \begin_layout Description
2807 Syntax layout-module-add <MODULE>
2810 \begin_layout Description
2811 Params <MODULE>: the module to be added
2814 \begin_layout Description
2815 Origin rgh, 25 August 2007
2818 \begin_layout Subsection*
2822 \begin_layout Description
2823 Action Reloads layout information.
2826 \begin_layout Description
2827 Notion Reloads all layout information for the current buffer from disk,
2828 thus recognizing any changes that have been made to layout files on the
2830 This is intended to be used only by layout developers and should not be
2831 used when one is trying to do actual work.
2834 \begin_layout Description
2835 Syntax layout-reload
2838 \begin_layout Description
2839 Origin rgh, 3 September 2007
2842 \begin_layout Subsection*
2843 LFUN_TEXTCLASS_APPLY
2846 \begin_layout Description
2847 Action Sets the text class for the current buffer.
2850 \begin_layout Description
2851 Syntax textclass-apply <TEXTCLASS>
2854 \begin_layout Description
2855 Params <TEXTCLASS>: the textclass to set.
2856 Note that this must be the filename, minus the ".layout" extension.
2859 \begin_layout Subsection*
2863 \begin_layout Description
2864 Action Loads information for a textclass from disk.
2867 \begin_layout Description
2868 Syntax textclass-load <TEXTCLASS>
2871 \begin_layout Description
2872 Params <TEXTCLASS>: the textclass to load.
2873 Note that this must be the filename, minus the ".layout" extension.
2876 \begin_layout Subsection*
2880 \begin_layout Description
2881 Action Disable selecting of text-region.
2884 \begin_layout Description
2888 \begin_layout Subsection*
2892 \begin_layout Description
2893 Action Enable selecting of text-region.
2896 \begin_layout Description
2897 Notion After enabling you can simply move arrow keys to get selected region.
2900 \begin_layout Description
2904 \begin_layout Subsection*
2908 \begin_layout Description
2909 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
2912 \begin_layout Description
2916 \begin_layout Description
2917 Origin Andre, May 5 2006
2920 \begin_layout Subsection*
2924 \begin_layout Description
2925 Action Inserts math delimiters (e.g.
2926 parentheses, brackets) enclosing expression.
2929 \begin_layout Description
2930 Syntax math-delim [<LEFT>] [<RIGHT>]
2933 \begin_layout Description
2934 Params <LEFT/RIGHT>: Delimiters to be used.
2935 Each delimiter can be specified by either a LaTeX name or a valid character.
2936 ( is the default letter.
2939 \begin_layout Description
2940 Sample math-delim { rangle
2943 \begin_layout Description
2944 Origin Alejandro, 18 Jun 1996
2947 \begin_layout Subsection*
2951 \begin_layout Description
2952 Action Inserts math fixed size delimiters (e.g.
2953 parentheses, brackets) enclosing expression.
2956 \begin_layout Description
2957 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
2960 \begin_layout Description
2961 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
2962 \begin_inset Newline newline
2965 <L/RDELIM>: TeX code for delimiter.
2966 See Delimiter dialog for delimiters to be used.
2969 \begin_layout Description
2970 Sample math-bigdelim "Bigl" "
2977 \begin_layout Description
2978 Origin Enrico & Georg, 7 May 2006
2981 \begin_layout Subsection*
2985 \begin_layout Description
2986 Action Creates a new displayed equation in text mode.
2987 Toggles inlined/display formula in math mode.
2990 \begin_layout Description
2991 Syntax math-display [<ARG>]
2994 \begin_layout Description
2995 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating
2996 new equation from the text mode.
2999 \begin_layout Description
3000 Origin Alejandro, 18 Jun 1996
3003 \begin_layout Subsection*
3007 \begin_layout Description
3008 Action Inserts math objects and symbols.
3011 \begin_layout Description
3012 Notion When <ARG> is a _single_ math inset with more than one cell (such
3015 frac{x}{y}"), the content of cell(0) is replaced by the current selection
3016 (only works if the selection is in mathed).
3017 As an example, if "abc" is selected in mathed, "math-insert
3019 frac{x}{y}" replaces "abc" with "
3021 frac{abc}{y}", and "math-insert x_y^z" replaces "abc" with "abc_y^z".
3022 If nothing is selected (or the selection is not in mathed), math-insert
3026 \begin_layout Description
3027 Syntax math-insert <ARG>
3030 \begin_layout Description
3031 Params <ARG>: Symbol or LaTeX code to be inserted.
3034 \begin_layout Subsection*
3038 \begin_layout Description
3039 Action Enters subscript expression in math expression.
3042 \begin_layout Description
3043 Syntax math-subscript
3046 \begin_layout Description
3047 Origin vermeer, 12 Dec 2001
3050 \begin_layout Subsection*
3051 LFUN_MATH_SUPERSCRIPT
3054 \begin_layout Description
3055 Action Enters superscript expression in math expression.
3058 \begin_layout Description
3059 Syntax math-superscript
3062 \begin_layout Description
3063 Origin vermeer, 12 Dec 2001
3066 \begin_layout Subsection*
3070 \begin_layout Description
3071 Action Toggles the position of the limits from above/below to the right
3072 side an vice versa in integral symbol, a limit, a summation, etc.
3075 \begin_layout Description
3076 Notion Put the cursor before the symbol with the limits and then invoke
3080 \begin_layout Description
3081 Syntax math-limits [<STATE>]
3084 \begin_layout Description
3085 Params <STATE>: limits|nolimits
3088 \begin_layout Subsection*
3092 \begin_layout Description
3093 Action Inserts a math macro definition at the cursor position in the text.
3096 \begin_layout Description
3097 Syntax math-macro <NAME> [<NARGS>] [def]
3100 \begin_layout Description
3101 Params <NAME>: The name of the macro, e.g.
3103 \begin_inset Newline newline
3106 <NARGS>: The number of parameters of the macro.
3108 "def": Has no effect anymore, just for compatibility with former LyX versions.
3111 \begin_layout Description
3112 Origin ale, 10 May 1997; sts, 21 Dec 2007
3115 \begin_layout Subsection*
3119 \begin_layout Description
3120 Action Mutates the type of math inset to the newly selected one.
3123 \begin_layout Description
3124 Syntax math-mutate <TYPE>
3127 \begin_layout Description
3128 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
3129 multline|gather|flalign
3132 \begin_layout Description
3133 Origin Andre, 23 May 2001
3136 \begin_layout Subsection*
3140 \begin_layout Description
3141 Action Inserts space into math expression.
3144 \begin_layout Description
3145 Notion Use spacebar after entering this space to change type of space.
3148 \begin_layout Description
3149 Syntax math-space [<TYPE>] [<LEN>]
3152 \begin_layout Description
3153 Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
3154 \begin_inset Newline newline
3157 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
3158 \begin_inset Newline newline
3161 custom space: hspace
3162 \begin_inset Newline newline
3165 "," used by default.
3166 \begin_inset Newline newline
3169 Note that ! is equivalent to negthinspace, , = thinspace, : = medspace,
3171 \begin_inset Newline newline
3174 <LEN>: length for custom spaces (hspace)
3177 \begin_layout Description
3178 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
3181 \begin_layout Subsection*
3185 \begin_layout Description
3186 Action Inserts a matrix.
3189 \begin_layout Description
3190 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
3193 \begin_layout Description
3194 Params <ALIGN>: Alignment is a word composed of the vertical alignment (b,
3196 1 char) and the horizontal alignments (l, c or r) (i.e.
3200 \begin_layout Description
3201 Sample math-matrix 3 3 bccc
3204 \begin_layout Subsection*
3205 LFUN_MATH_AMS_MATRIX
3208 \begin_layout Description
3209 Action Inserts a matrix.
3212 \begin_layout Description
3213 Syntax math-matrix <COLS> <ROWS> [<DECORATION>]
3216 \begin_layout Description
3217 Params <DECORATION>: Decoration determines the LaTeX name of the matrix
3218 that should be created.
3221 \begin_layout Description
3222 Sample math-ams-matrix 3 3 bmatrix
3225 \begin_layout Subsection*
3229 \begin_layout Description
3230 Action In text mode enters math mode (i.e.
3231 puts math insets on the current cursor position), in math mode enters text
3232 mode inside math expression.
3235 \begin_layout Description
3236 Notion If there is some selected text, it puts the text inside created math
3240 \begin_layout Description
3241 Syntax math-mode [on|<ARG>]
3244 \begin_layout Description
3245 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT
3247 \begin_inset Newline newline
3250 "on": allow only entering of math mode from text mode.
3253 \begin_layout Description
3254 Origin Alejandro, 4 Jun 1996
3257 \begin_layout Subsection*
3261 \begin_layout Description
3262 Action Enters regexp mode (i.e., puts regexp insets on the current cursor
3264 Used by the advanced search dialog.
3267 \begin_layout Description
3268 Notion If there is any selected text, then it is moved inside the created
3272 \begin_layout Description
3273 Syntax regexp-mode [<ARG>]
3276 \begin_layout Description
3277 Params <ARG>: eventual argument (regular expression).
3280 \begin_layout Description
3281 Origin Tommaso, 4 Oct 2008
3284 \begin_layout Subsection*
3285 LFUN_MATH_NUMBER_LINE_TOGGLE
3288 \begin_layout Description
3289 Action Toggles numbering of the current formula line.
3292 \begin_layout Description
3293 Notion Must be in display formula mode.
3296 \begin_layout Description
3297 Syntax math-number-line-toggle
3300 \begin_layout Description
3301 Origin Alejandro, 18 Jun 1996
3304 \begin_layout Subsection*
3305 LFUN_MATH_NUMBER_TOGGLE
3308 \begin_layout Description
3309 Action Toggles numbering/labeling of the current formula.
3312 \begin_layout Description
3313 Notion Must be in display formula mode.
3316 \begin_layout Description
3317 Syntax math-number-toggle
3320 \begin_layout Description
3321 Origin Alejandro, 4 Jun 1996
3324 \begin_layout Subsection*
3328 \begin_layout Description
3329 Action Calls external program and passes the current expression/equation
3330 as an argument for the calculation in the format appropriate to the given
3334 \begin_layout Description
3335 Notion Selection can be used to determine the input for the external program.
3338 \begin_layout Description
3339 Syntax math-extern <LANG> [<COMMAND>]
3342 \begin_layout Description
3343 Params <LANG>: octave|maxima|maple|mathematica|script
3344 \begin_inset Newline newline
3347 where "script" stands for the external script (normalized expression will
3351 \begin_layout Description
3352 Sample math-extern maple simplify
3355 \begin_layout Description
3356 Origin Andre, 24 Apr 2001
3359 \begin_layout Subsection*
3363 \begin_layout Description
3364 Action Changes arbitrarily the size used by math fonts inside a context.
3367 \begin_layout Description
3368 Notion Provides an interface to the LaTeX math mode font size commands.
3371 \begin_layout Description
3372 Syntax math-size <STYLE>
3375 \begin_layout Description
3387 \begin_layout Description
3388 Origin Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
3391 \begin_layout Subsection*
3392 LFUN_MATH_FONT_STYLE
3395 \begin_layout Description
3396 Action Changes the text style used in math.
3399 \begin_layout Description
3400 Syntax math-font-style <STYLE>
3403 \begin_layout Description
3404 Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal
3405 \begin_inset Newline newline
3408 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
3411 \begin_layout Description
3412 Origin vfr, 9 jan 2009
3415 \begin_layout Subsection*
3416 LFUN_MATH_MACRO_UNFOLD
3419 \begin_layout Description
3420 Action Unfold a Math Macro.
3423 \begin_layout Description
3424 Notion Unfold the Math Macro the cursor is in, i.e.
3430 \begin_layout Description
3431 Syntax math-macro-unfold
3434 \begin_layout Description
3435 Origin sts, 06 January 2008
3438 \begin_layout Subsection*
3439 LFUN_MATH_MACRO_FOLD
3442 \begin_layout Description
3443 Action Fold a Math Macro.
3446 \begin_layout Description
3447 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e.
3453 \begin_layout Description
3454 Syntax math-macro-fold
3457 \begin_layout Description
3458 Origin sts, 06 January 2008
3461 \begin_layout Subsection*
3462 LFUN_MATH_MACRO_ADD_PARAM
3465 \begin_layout Description
3466 Action Add a parameter.
3469 \begin_layout Description
3470 Notion Add a parameter to a Math Macro.
3473 \begin_layout Description
3474 Syntax math-macro-add-param <NUM>
3477 \begin_layout Description
3478 Params <NUM>: The number of the parameter behind which the new one will
3479 be added (1 for the first, i.e.
3480 use 0 for add a parameter at the left), defaults to the last one.
3483 \begin_layout Description
3484 Origin sts, 06 January 2008
3487 \begin_layout Subsection*
3488 LFUN_MATH_MACRO_REMOVE_PARAM
3491 \begin_layout Description
3492 Action Remove the last parameter.
3495 \begin_layout Description
3496 Notion Remove the last parameter of a Math Macro and remove its value in
3497 all instances of the macro in the buffer.
3500 \begin_layout Description
3501 Syntax math-macro-remove-param <NUM>
3504 \begin_layout Description
3505 Params <NUM>: The number of the parameter to be deleted (1 for the first),
3506 defaults to the last one.
3509 \begin_layout Description
3510 Origin sts, 06 January 2008
3513 \begin_layout Subsection*
3514 LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
3517 \begin_layout Description
3518 Action Append a greedy parameter.
3521 \begin_layout Description
3522 Notion Append a greedy parameter to a Math Macro which eats the following
3523 mathed cell in every instance of the macro in the buffer.
3526 \begin_layout Description
3527 Syntax math-macro-append-greedy-param
3530 \begin_layout Description
3531 Origin sts, 06 January 2008
3534 \begin_layout Subsection*
3535 LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
3538 \begin_layout Description
3539 Action Remove a greedy parameter.
3542 \begin_layout Description
3543 Notion Remove a greedy parameter of a Math Macro and spit out the values
3544 of it in every instance of the macro in the buffer.
3545 If it is an optional parameter the [valud] format is used.
3548 \begin_layout Description
3549 Syntax math-macro-remove-greedy-param
3552 \begin_layout Description
3553 Origin sts, 06 January 2008
3556 \begin_layout Subsection*
3557 LFUN_MATH_MACRO_MAKE_OPTIONAL
3560 \begin_layout Description
3561 Action Make a parameter optional.
3564 \begin_layout Description
3565 Notion Turn the first non-optional parameter of a Math Macro into an optional
3566 parameter with a default value.
3569 \begin_layout Description
3570 Syntax math-macro-make-optional
3573 \begin_layout Description
3574 Origin sts, 06 January 2008
3577 \begin_layout Subsection*
3578 LFUN_MATH_MACRO_MAKE_NONOPTIONAL
3581 \begin_layout Description
3582 Action Make a parameter non-optional.
3585 \begin_layout Description
3586 Notion Turn the last optional parameter of a Math Macro into a non-optional
3588 The default value is remembered to be reused later if the user changes
3592 \begin_layout Description
3593 Syntax math-macro-make-nonoptional
3596 \begin_layout Description
3597 Origin sts, 06 January 2008
3600 \begin_layout Subsection*
3601 LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
3604 \begin_layout Description
3605 Action Add an optional parameter.
3608 \begin_layout Description
3609 Notion Insert an optional parameter just behind the already existing optional
3613 \begin_layout Description
3614 Syntax math-macro-add-optional-param
3617 \begin_layout Description
3618 Origin sts, 06 January 2008
3621 \begin_layout Subsection*
3622 LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
3625 \begin_layout Description
3626 Action Remove the last optional parameter.
3629 \begin_layout Description
3630 Notion Remove the last optional parameter of a Math Macro and remove it
3631 in all the instances of the macro in the buffer.
3634 \begin_layout Description
3635 Syntax math-macro-remove-optional-param
3638 \begin_layout Description
3639 Origin sts, 06 January 2008
3642 \begin_layout Subsection*
3643 LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
3646 \begin_layout Description
3647 Action Add a greedy optional parameter.
3650 \begin_layout Description
3651 Notion Add a greedy optional parameter which eats the value from the following
3652 cells in mathed which are in the [value] format.
3655 \begin_layout Description
3656 Syntax math-macro-add-greedy-optional-param
3659 \begin_layout Description
3660 Origin sts, 06 January 2008
3663 \begin_layout Subsection*
3664 LFUN_IN_MATHMACROTEMPLATE
3667 \begin_layout Description
3668 Action Only active in Math Macro definition.
3671 \begin_layout Description
3672 Notion Dummy function which is only active in a Math Macro definition.
3673 It's used to toggle the Math Macro toolbar if the cursor moves into a Math
3677 \begin_layout Description
3678 Syntax in-mathmacrotemplate
3681 \begin_layout Description
3682 Origin sts, 06 January 2008
3685 \begin_layout Subsection*
3686 LFUN_PARAGRAPH_MOVE_DOWN
3689 \begin_layout Description
3690 Action Moves the current paragraph downwards in the document.
3693 \begin_layout Description
3694 Syntax paragraph-move-down
3697 \begin_layout Description
3698 Origin Edwin, 8 Apr 2006
3701 \begin_layout Subsection*
3702 LFUN_PARAGRAPH_MOVE_UP
3705 \begin_layout Description
3706 Action Moves the current paragraph upwards in the document.
3709 \begin_layout Description
3710 Notion Movement through the document will possibly break the paragraph-depth
3715 \begin_layout Description
3716 Syntax paragraph-move-up
3719 \begin_layout Description
3720 Origin Edwin, 8 Apr 2006
3723 \begin_layout Subsection*
3727 \begin_layout Description
3728 Action Move the cursor to the next paragraph (or beginning of the current
3729 one) in upward direction.
3732 \begin_layout Description
3736 \begin_layout Description
3737 Origin Asger, 1 Oct 1996
3740 \begin_layout Subsection*
3741 LFUN_PARAGRAPH_UP_SELECT
3744 \begin_layout Description
3745 Action Move the cursor and select the text to the next paragraph (or beginning
3746 of the current one) in upward direction.
3749 \begin_layout Description
3750 Syntax paragraph-up-select
3753 \begin_layout Description
3754 Origin Asger, 1 Oct 1996
3757 \begin_layout Subsection*
3761 \begin_layout Description
3762 Action Move the cursor to the next paragraph (or beginning of the current
3763 one) in downward direction.
3766 \begin_layout Description
3767 Syntax paragraph-down
3770 \begin_layout Description
3771 Origin Asger, 1 Oct 1996
3774 \begin_layout Subsection*
3775 LFUN_PARAGRAPH_DOWN_SELECT
3778 \begin_layout Description
3779 Action Move the cursor and select the text to the next paragraph (or beginning
3780 of the current one) in downward direction.
3783 \begin_layout Description
3784 Syntax paragraph-down-select
3787 \begin_layout Description
3788 Origin Asger, 1 Oct 1996
3791 \begin_layout Subsection*
3795 \begin_layout Description
3796 Action Jump to a paragraph given by its id number and optionally the desired
3797 position within the paragraph.
3800 \begin_layout Description
3801 Notion Note that id number of paragraph is not the sequential number of
3802 paragraph seen on the screen.
3803 Moreover the id is unique for all opened buffers (documents).
3806 \begin_layout Description
3807 Syntax paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
3810 \begin_layout Description
3811 Params <PAR_ID_NUMBER>: paragraph id
3812 \begin_inset Newline newline
3815 <POSITION_IN_PAR>: desired position within the paragraph
3818 \begin_layout Description
3819 Origin Dekel, 26 Aug 2000
3822 \begin_layout Subsection*
3823 LFUN_PARAGRAPH_BREAK
3826 \begin_layout Description
3827 Action Breaks the current paragraph at the current location.
3830 \begin_layout Description
3831 Notion Removes the selection.
3834 \begin_layout Description
3835 Syntax paragraph-break [<LAYOUT>]
3838 \begin_layout Description
3839 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to
3840 default layout) when the cursor is at the end of the line.
3843 \begin_layout Subsection*
3844 LFUN_PARAGRAPH_PARAMS
3847 \begin_layout Description
3848 Action Change paragraph settings.
3851 \begin_layout Description
3852 Notion Modifies the current paragraph, or currently selected paragraphs.
3853 This function only modifies, and does not override, existing settings.
3854 Note that the "leftindent" indent setting is deprecated.
3857 \begin_layout Description
3858 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
3861 \begin_layout Description
3871 \begin_inset Newline newline
3876 paragraph_spacing default|single|onehalf|double|other SIZE
3877 \begin_inset Newline newline
3882 align block|left|right|center|default
3883 \begin_inset Newline newline
3888 labelwidthstring WIDTH|
3893 \begin_layout Description
3894 Origin rgh, Aug 15 2007
3897 \begin_layout Subsection*
3898 LFUN_PARAGRAPH_PARAMS_APPLY
3901 \begin_layout Description
3902 Action Change paragraph settings.
3905 \begin_layout Description
3906 Notion Overwrite all nonspecified settings to the default ones.
3907 Use paragraph-params lfun if you don't want to overwrite others settings.
3910 \begin_layout Description
3911 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
3914 \begin_layout Description
3915 Params For parameters see LFUN_PARAGRAPH_PARAMS
3918 \begin_layout Description
3919 Origin leeming, 30 Mar 2004
3922 \begin_layout Subsection*
3923 LFUN_PARAGRAPH_UPDATE
3926 \begin_layout Description
3927 Action Updates the values inside the paragraph dialog from the paragraph.
3930 \begin_layout Description
3931 Notion This is an internal LFUN, not to be used by users.
3932 Called internally by LFUN_DIALOG_UPDATE.
3935 \begin_layout Description
3936 Origin leeming, 13 Mar 2003
3939 \begin_layout Subsection*
3943 \begin_layout Description
3944 Action Move the current group in the upward direction in the structure of
3948 \begin_layout Description
3949 Notion The "group" can be Part/Chapter/Section/etc.
3950 It moves the whole substructure of the group.
3953 \begin_layout Description
3957 \begin_layout Description
3958 Origin Vermeer, 23 Mar 2006
3961 \begin_layout Subsection*
3965 \begin_layout Description
3966 Action Move the current group in the downward direction in the structure
3970 \begin_layout Description
3971 Notion The "group" can be Part/Chapter/Section/etc.
3972 It moves the whole substructure of the group.
3975 \begin_layout Description
3979 \begin_layout Description
3980 Origin Vermeer, 23 Mar 2006
3983 \begin_layout Subsection*
3987 \begin_layout Description
3988 Action Moves the current group in the downward direction in the hierarchy
3989 of the document structure.
3992 \begin_layout Description
3993 Notion Part -> Chapter -> Section -> etc.
3996 \begin_layout Description
4000 \begin_layout Description
4001 Origin Vermeer, 23 Mar 2006
4004 \begin_layout Subsection*
4008 \begin_layout Description
4009 Action Moves the current group in the upward direction in the hierarchy
4010 of the document structure.
4013 \begin_layout Description
4014 Notion Part <- Chapter <- Section <- etc.
4017 \begin_layout Description
4021 \begin_layout Description
4022 Origin Vermeer, 23 Mar 2006
4025 \begin_layout Subsection*
4029 \begin_layout Description
4030 Action Edit the inset at cursor with an external application, if one is
4034 \begin_layout Description
4035 Syntax inset-edit [<INSET_PARAMS>]
4038 \begin_layout Description
4039 Params <INSET_PARAMS>: Parameters for the inset.
4040 \begin_inset Newline newline
4043 Currently only the filename will be considered.
4046 \begin_layout Description
4047 Origin JSpitzm, 27 Apr 2006
4050 \begin_layout Subsection*
4054 \begin_layout Description
4055 Action Inserts table into the document.
4058 \begin_layout Description
4059 Notion See LFUN_INSET_MODIFY for some more details about tabular modifications.
4062 \begin_layout Description
4063 Syntax tabular-insert [<ROWS> <COLUMNS>]
4066 \begin_layout Description
4067 Params In case no arguments are given show insert dialog.
4070 \begin_layout Description
4071 Origin Jug, 12 Apr 2000
4074 \begin_layout Subsection*
4078 \begin_layout Description
4079 Action Moves the cursor to the previous cell inside the table.
4082 \begin_layout Description
4083 Syntax cell-backward
4086 \begin_layout Description
4087 Origin Jug, 22 May 2000
4090 \begin_layout Subsection*
4094 \begin_layout Description
4095 Action Moves the cursor to the next cell inside the table.
4098 \begin_layout Description
4102 \begin_layout Subsection*
4106 \begin_layout Description
4107 Action Splits cell and shifts right part to the next cell (inside the math
4111 \begin_layout Description
4115 \begin_layout Description
4116 Origin Ale, 15 May 1997
4119 \begin_layout Subsection*
4123 \begin_layout Description
4124 Action Register the document as an file inside version control system.
4127 \begin_layout Description
4128 Notion File is registered inside cvs, svn or rcs repository acording to
4129 the existence of cvs/svn/rcs entries in the document's directory.
4130 \begin_inset Newline newline
4133 See LyX Additional Features Manual (Version Control Chapter) for additional
4137 \begin_layout Description
4141 \begin_layout Description
4142 Origin Lgb, 1 Jul 1997
4145 \begin_layout Subsection*
4149 \begin_layout Description
4150 Action Renames the document to another name.
4153 \begin_layout Description
4154 Notion Renaming with revision history is only supported by SVN.
4155 For CVS it is simulated by adding the document under a new name and deleting
4157 For RCS it is not supported.
4158 Disabled if uncommitted changes exist.
4161 \begin_layout Description
4162 Syntax vc-rename <FILENAME>
4165 \begin_layout Description
4166 Params <FILENAME>: New name of the document.
4167 \begin_inset Newline newline
4170 A file dialog is opened if no filename is given.
4173 \begin_layout Description
4174 Origin gb, 05 Feb 2013
4177 \begin_layout Subsection*
4181 \begin_layout Description
4182 Action Copies the document to another name.
4185 \begin_layout Description
4186 Notion Copying with revision history is only supported by SVN.
4187 For RCS and CVS it is simulated by adding the document under a new name.
4188 Disabled if uncommitted changes exist.
4191 \begin_layout Description
4192 Syntax vc-copy <FILENAME>
4195 \begin_layout Description
4196 Params <FILENAME>: New name of the document.
4197 \begin_inset Newline newline
4200 A file dialog is opened if no filename is given.
4203 \begin_layout Description
4204 Origin gb, 05 Feb 2013
4207 \begin_layout Subsection*
4211 \begin_layout Description
4212 Action Checks-in/commits the changes of the registered file to the repository.
4215 \begin_layout Description
4216 Notion In RCS case this also unlocks the file.
4219 \begin_layout Description
4223 \begin_layout Description
4224 Origin Lgb, 1 Jul 1997
4227 \begin_layout Subsection*
4231 \begin_layout Description
4232 Action Checks-out the document for edit (and locks it in some cases).
4235 \begin_layout Description
4239 \begin_layout Description
4240 Origin Lgb, 1 Jul 1997
4243 \begin_layout Subsection*
4247 \begin_layout Description
4248 Action Reverts the document to the last check-in/commit in VCS.
4251 \begin_layout Description
4255 \begin_layout Description
4256 Origin Lgb, 1 Jul 1997
4259 \begin_layout Subsection*
4263 \begin_layout Description
4264 Action Undo last check-in.
4267 \begin_layout Description
4268 Notion This is currently implemented only for RCS.
4271 \begin_layout Description
4275 \begin_layout Description
4276 Origin Lgb, 1 Jul 1997
4279 \begin_layout Subsection*
4283 \begin_layout Description
4284 Action Executes external command.
4285 This command is intended to support additional VCS commands.
4288 \begin_layout Description
4289 Syntax vc-command <FLAG> <PATH> <COMMAND>
4292 \begin_layout Description
4293 Params <FLAG>: Flags for the command can be combined together.
4294 \begin_inset Newline newline
4297 U - dUmmy - no flags
4298 \begin_inset Newline newline
4301 D - Doc - need document loaded to proceed
4302 \begin_inset Newline newline
4305 I - dIrty - mark document dirty
4306 \begin_inset Newline newline
4309 R - Reload - ensure that the document is saved and reload it after command
4311 \begin_inset Newline newline
4314 M - Message - ask for input string (commit message)
4315 \begin_inset Newline newline
4318 <PATH>: path where to start.
4319 $$p will be replaced by the current document path.
4320 \begin_inset Newline newline
4323 <COMMAND>: command to execute.
4324 $$i/$$p/$$m will be replaced by the current document(with absolute path)/path/m
4328 \begin_layout Description
4329 Sample vc-command DR $$p "svn up"
4332 \begin_layout Description
4333 Origin sanda, 13 Jan 2009
4336 \begin_layout Subsection*
4337 LFUN_VC_LOCKING_TOGGLE
4340 \begin_layout Description
4341 Action Toggles the locking property of the edited file.
4344 \begin_layout Description
4345 Notion This is currently implemented only for SVN.
4348 \begin_layout Description
4349 Syntax vc-locking-toggle
4352 \begin_layout Description
4353 Origin sanda, 25 Jun 2009
4356 \begin_layout Subsection*
4360 \begin_layout Description
4361 Action Update the local archive directory in which resides the current document
4362 with the remote repository.
4365 \begin_layout Description
4366 Syntax vc-repo-update
4369 \begin_layout Description
4370 Origin sanda, 16 Oct 2009
4373 \begin_layout Subsection*
4377 \begin_layout Description
4378 Action Compares two revisions of the same file under version control.
4381 \begin_layout Description
4382 Syntax vc-compare [<REV1>] [<REV2>]
4385 \begin_layout Description
4386 Params Revision number either points directly to commit in history or if
4387 negative number -x it points to (last commit - x).
4388 \begin_inset Newline newline
4391 In RCS we subtract only in the last number of revision specification.
4392 Special case "0" is reserved for the last committed revision.
4393 \begin_inset Newline newline
4397 \begin_inset Newline newline
4401 Used only if REV1 > 0.
4402 \begin_inset Newline newline
4405 If no parameter is given, interactive dialog will be shown.
4408 \begin_layout Description
4409 Sample Compare current document against last commit
4410 \begin_inset Newline newline
4414 \begin_inset Newline newline
4417 Compare current document against current revision - 5 commits
4418 \begin_inset Newline newline
4422 \begin_inset Newline newline
4425 Compare revisions 120 and 155
4426 \begin_inset Newline newline
4432 \begin_layout Description
4433 Origin sanda, 12 Feb 2010
4436 \begin_layout Subsection*
4440 \begin_layout Description
4441 Action Toggles change tracking to on/off.
4444 \begin_layout Description
4445 Syntax changes-track
4448 \begin_layout Description
4449 Origin levon, 1 Oct 2002
4452 \begin_layout Subsection*
4456 \begin_layout Description
4457 Action Toggles showing of change tracking in typesetted output.
4460 \begin_layout Description
4461 Syntax changes-output
4464 \begin_layout Description
4465 Origin jspitzm, 21 Jan 2005
4468 \begin_layout Subsection*
4472 \begin_layout Description
4473 Action Moves the cursor to the position of the next change of the change
4477 \begin_layout Description
4481 \begin_layout Description
4482 Origin schmitt, 4 Oct 2006
4485 \begin_layout Subsection*
4486 LFUN_CHANGE_PREVIOUS
4489 \begin_layout Description
4490 Action Moves the cursor to the position of the previous change of the change
4494 \begin_layout Description
4495 Syntax change-previous
4498 \begin_layout Description
4499 Origin vfr, 4 Apr 2009
4502 \begin_layout Subsection*
4506 \begin_layout Description
4507 Action Open change tracking dialog for merging and moves the cursor to the
4508 position of the next change.
4511 \begin_layout Description
4512 Syntax changes-merge
4515 \begin_layout Description
4516 Origin Levon, 16 Oct 2002
4519 \begin_layout Subsection*
4523 \begin_layout Description
4524 Action Accepts tracked change inside the selection.
4527 \begin_layout Description
4528 Syntax change-accept
4531 \begin_layout Description
4532 Origin Levon, 16 Oct 2002
4535 \begin_layout Subsection*
4539 \begin_layout Description
4540 Action Rejects tracked change inside the selection.
4543 \begin_layout Description
4544 Syntax change-reject
4547 \begin_layout Description
4548 Origin Levon, 16 Oct 2002
4551 \begin_layout Subsection*
4552 LFUN_ALL_CHANGES_ACCEPT
4555 \begin_layout Description
4556 Action Accepts all tracked changes in the document.
4559 \begin_layout Description
4560 Syntax all-changes-accept
4563 \begin_layout Description
4564 Origin Levon, 16 Oct 2002
4567 \begin_layout Subsection*
4568 LFUN_ALL_CHANGES_REJECT
4571 \begin_layout Description
4572 Action Rejects all tracked changes in the document.
4575 \begin_layout Description
4576 Notion Reject does not work recursively; the user may have to repeat the
4580 \begin_layout Description
4581 Syntax all-changes-reject
4584 \begin_layout Description
4585 Origin Levon, 16 Oct 2002
4588 \begin_layout Subsection*
4592 \begin_layout Description
4593 Action Apply data for an inset.
4596 \begin_layout Description
4597 Notion LFUN_INSET_APPLY is sent from the dialogs when the data should be
4599 This is either changed to LFUN_INSET_MODIFY or LFUN_INSET_INSERT depending
4600 on the context where it is called.
4603 \begin_layout Description
4604 Syntax inset-apply <ARGS>
4607 \begin_layout Description
4608 Params See LFUN_INSET_INSERT .
4611 \begin_layout Subsection*
4615 \begin_layout Description
4616 Action Dissolve the current inset into text.
4619 \begin_layout Description
4620 Syntax inset-dissolve [<INSET>]
4623 \begin_layout Description
4624 Params <INSET>: this can be used to make sure the right kind of inset is
4626 For example "dissolve" entry in the charstyles sub-menu should only dissolve
4627 the charstyle inset, even if the cursor is inside several nested insets
4629 \begin_inset Newline newline
4632 For values see lyx::InsetLayout::lyxtype_ .
4635 \begin_layout Description
4636 Origin JSpitz, 7 Aug 2006
4639 \begin_layout Subsection*
4643 \begin_layout Description
4644 Action Insert new inset (type given by the parameters).
4647 \begin_layout Description
4648 Syntax inset-insert <INSET> <ARGS>
4651 \begin_layout Description
4652 Params <INSET>: <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|
4653 \begin_inset Newline newline
4656 hyperlink|include|index|label|line|nomencl|vspace|ref|toc|scri
4658 \begin_inset Newline newline
4661 <ARGS>: depends on the given inset.
4662 Use "lyx -dbg action" to explore.
4665 \begin_layout Description
4666 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
4669 \begin_inset Newline newline
4672 where <label name> is the name of the referenced label and <Format> is one
4674 \begin_inset Newline newline
4678 \begin_inset Newline newline
4681 eqref -- (<reference>)
4682 \begin_inset Newline newline
4686 \begin_inset Newline newline
4689 vpageref -- on <page>
4690 \begin_inset Newline newline
4693 vref -- <reference> on <page>
4694 \begin_inset Newline newline
4697 formatted -- Formatted reference
4700 \begin_layout Subsection*
4704 \begin_layout Description
4705 Action Modify some properties of an inset.
4708 \begin_layout Description
4709 Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats,
4710 graphics, include, index, info, label, listings, newline, newpage, nomencl,
4711 note, phantom, ref, space, tabular, vspace, wrap insets.
4714 \begin_layout Description
4715 Syntax inset-modify <INSET> <ARGS>inset-modify changetype <TYPE>inset-modify
4716 tabular <FEATURE> [<ARG>]
4719 \begin_layout Description
4720 Params Generally see LFUN_INSET_INSERT for further details.
4721 \begin_inset Newline newline
4724 In case that <INSET> is "tabular" various math-environment features are
4725 handled as well, e.g.
4726 add-vline-left/right for the Grid/Array environment.
4727 \begin_inset Newline newline
4730 <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|copy-colum
4731 n| toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
4732 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point
4733 | valign-top|valign-bottom|valign-middle|longtabular-align-left| longtabular-ali
4734 gn-center|longtabular-align-right|m-align-left|m-align-right| m-align-center|m-v
4735 align-top|m-valign-bottom|m-valign-middle|multicolumn| set-all-lines|unset-all-l
4736 ines|set-longtabular|unset-longtabular|set-pwidth| set-mpwidth|set-rotate-tabula
4737 r|unset-rotate-tabular|toggle-rotate-tabular| set-rotate-cell|unset-rotate-cell|
4738 toggle-rotate-cell|set-usebox|set-lthead| unset-lthead|set-ltfirsthead|unset-ltf
4739 irsthead|set-ltfoot|unset-ltfoot| set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|
4740 toggle-ltcaption| set-special-column|set-special-multicolumn|set-special-multiro
4741 w| set-booktabs|unset-booktabs|set-top-space|set-bottom-space| set-interline-spa
4742 ce|set-border-lines|tabular-valign-top| tabular-valign-middle|tabular-valign-bot
4743 tom|set-tabular-width
4744 \begin_inset Newline newline
4747 <ARG>: additional argument for some commands, use debug mode to explore
4751 \begin_layout Description
4752 Sample inset-modify note Note Comment
4753 \begin_inset Newline newline
4756 inset-modify changetype Ovalbox
4759 \begin_layout Subsection*
4760 LFUN_INSET_DIALOG_UPDATE
4763 \begin_layout Description
4764 Action Updates the values inside the dialog from the inset.
4767 \begin_layout Description
4768 Notion This is an internal LFUN, not to be used by users.
4769 Called internally by LFUN_DIALOG_UPDATE
4772 \begin_layout Description
4773 Params <DIALOG-NAME>
4776 \begin_layout Description
4777 Origin leeming, 25 Feb 2003
4780 \begin_layout Subsection*
4784 \begin_layout Description
4785 Action Open the inset's properties dialog.
4788 \begin_layout Description
4789 Notion Used for bibitem, bibtex, box, branch, citation, ert, external, float,
4790 graphics, href, include, index, index_print, label, line, listings, note,
4791 phantom, ref, space, tabular, vspace, wrap insets.
4794 \begin_layout Description
4795 Syntax inset-settings <INSET>
4798 \begin_layout Description
4799 Params <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
4800 \begin_inset Newline newline
4803 graphics|href|include|index|index_print|label|line|
4804 \begin_inset Newline newline
4807 listings|note|phantom|ref|space|tabular|vspace|wrap>.
4810 \begin_layout Subsection*
4814 \begin_layout Description
4815 Action Toggles the collapsible inset at cursor position, or the inset we
4819 \begin_layout Description
4820 Syntax inset-toggle [<ARG>]
4823 \begin_layout Description
4824 Params <ARG>: <open|close|toggle|assign>.
4825 \begin_inset Newline newline
4828 open/close/toggle are for collapsible insets.
4829 toggle is used when no argument is given.
4830 \begin_inset Newline newline
4833 assign synchronize the branch-inset with activation status of the branch.
4834 Used for global toggling when changed activation.
4837 \begin_layout Description
4838 Origin lasgouttes, 19 Jul 2001
4841 \begin_layout Subsection*
4845 \begin_layout Description
4846 Action Apply the given commands on insets of a given name.
4849 \begin_layout Description
4850 Notion WARNING: use at your own risks; this function gives you too many
4851 ways of shooting yourself in the foot.
4852 A typical example is inset-forall Note note-insert which starts an infinite
4854 This is mitigated by the fact that the number of actions is arbitrarily
4856 Note also that inset-forall does not update metrics between iterations,
4857 which can lead to bugs.
4858 This has to be eventually fixed.
4861 \begin_layout Description
4862 Syntax inset-forall <NAME> <LFUN-COMMAND>
4863 \begin_inset Newline newline
4866 <NAME>: Type of Inset.
4867 If <NAME> is *, all insets are matched.
4868 The name is used like for InsetLayout in layout files: "Note" matches all
4869 note insets, while "Note:Note" only matches LyX yellow note insets.
4872 \begin_layout Description
4873 Sample Remove all index insets:
4874 \begin_inset Newline newline
4877 inset-forall Index char-delete-forward
4878 \begin_inset Newline newline
4881 Close all Notes (also works for a particular branch, for example):
4882 \begin_inset Newline newline
4885 inset-forall Note inset-toggle close
4886 \begin_inset Newline newline
4889 Transform all yellow notes to comments
4890 \begin_inset Newline newline
4893 inset-forall Note:Note inset-modify note Note Comment
4894 \begin_inset Newline newline
4897 Try to put LyX in an infinite loop if there is at least a Note:
4898 \begin_inset Newline newline
4901 inset-forall Note char-backward
4904 \begin_layout Description
4905 Origin lasgouttes, 27 Nov 2009
4908 \begin_layout Subsection*
4909 LFUN_GRAPHICS_RELOAD
4912 \begin_layout Description
4913 Action Reloads the image if necessary.
4916 \begin_layout Description
4917 Syntax graphics-reload
4920 \begin_layout Description
4921 Origin vfr, 10 Aug 2009
4924 \begin_layout Subsection*
4925 LFUN_SET_GRAPHICS_GROUP
4928 \begin_layout Description
4929 Action Set the group for the graphics inset on the cursor position.
4932 \begin_layout Description
4933 Syntax set-graphics-group [<GROUP>]
4936 \begin_layout Description
4937 Params <GROUP>: Id for an existing group.
4938 In case the Id is an empty string, the graphics inset is removed from the
4942 \begin_layout Description
4943 Origin sanda, 6 May 2008
4946 \begin_layout Subsection*
4947 LFUN_FINISHED_FORWARD
4950 \begin_layout Description
4951 Action Moves the cursor out of the current slice, going forward.
4954 \begin_layout Description
4955 Notion Cursor movement within an inset may be different than cursor movement
4956 in the surrounding text.
4957 This action should be called automatically by the cursor movement within
4958 the inset, when movement within the inset has ceased (reached the end of
4959 the last paragraph, for example), in order to move correctly back into
4960 the surrounding text.
4963 \begin_layout Subsection*
4964 LFUN_FINISHED_BACKWARD
4967 \begin_layout Description
4968 Action Moves the cursor out of the current slice, going backwards.
4971 \begin_layout Description
4972 Notion See also LFUN_FINISHED_FORWARD.
4975 \begin_layout Subsection*
4979 \begin_layout Description
4980 Action Moves the cursor out of the current slice, going right.
4983 \begin_layout Description
4984 Notion See also LFUN_FINISHED_FORWARD
4987 \begin_layout Subsection*
4991 \begin_layout Description
4992 Action Moves the cursor out of the current slice, going left.
4995 \begin_layout Description
4996 Notion See also LFUN_FINISHED_FORWARD.
4999 \begin_layout Subsection*
5003 \begin_layout Description
5004 Action Set language from the current cursor position.
5007 \begin_layout Description
5008 Syntax language <LANG> [set]
5011 \begin_layout Description
5012 Params <LANG>: Requested language.
5013 Look in lib/languages for the list.
5014 "language reset" or "language" (without param) reset to the document language.
5015 set: If used, the language will be set to the specified language.
5016 Otherwise, the language will be toggled (i.e., if the current language is
5017 LANG, switch to the document language or the default language, if LANG
5018 is the document language).
5021 \begin_layout Description
5022 Origin Dekel, 2 Mar 2000
5025 \begin_layout Subsection*
5029 \begin_layout Description
5030 Action Goto a label.
5033 \begin_layout Description
5034 Syntax label-goto [<LABEL>]
5037 \begin_layout Description
5038 Params <LABEL>: Requested label.
5039 If no label is given and reference is on cursor position, Bookmark 0 is
5040 saved and cursor moves to the position of referenced label.
5043 \begin_layout Description
5044 Origin Ale, 6 Aug 1997
5047 \begin_layout Subsection*
5051 \begin_layout Description
5052 Action Inserts label to text or displayed formula.
5055 \begin_layout Description
5056 Syntax label-insert [<LABEL>]
5059 \begin_layout Description
5060 Params <LABEL>: Requested label.
5061 If no label is given dialog requesting name will be opened.
5064 \begin_layout Subsection*
5068 \begin_layout Description
5069 Action Go to the next label or cross-reference.
5072 \begin_layout Description
5073 Syntax reference-next
5076 \begin_layout Description
5077 Origin Dekel, 14 Jan 2001
5080 \begin_layout Subsection*
5084 \begin_layout Description
5085 Action Moves the cursor to the numbered bookmark, opening the file if necessary.
5086 Note that bookmarks are saved per-session, not per file.
5089 \begin_layout Description
5090 Notion Bookmark 0 has a special purpose.
5091 It is automatically set
5092 \begin_inset Newline newline
5096 to the paragraph you are currently editing
5097 \begin_inset Newline newline
5101 to the paragraph from where you are jumping to the last-edited position
5103 \begin_inset Newline newline
5107 when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
5110 \begin_layout Description
5111 Syntax bookmark-goto <NUMBER>
5114 \begin_layout Description
5115 Params <NUMBER>: the number of the bookmark to restore.
5118 \begin_layout Description
5119 Origin Dekel, 27 January 2001
5122 \begin_layout Subsection*
5126 \begin_layout Description
5127 Action Save a bookmark.
5130 \begin_layout Description
5131 Notion Saves a numbered bookmark to the sessions file.
5132 The number must be between 1 and 9, inclusive.
5133 Note that bookmarks are saved per-session, not per file.
5136 \begin_layout Description
5137 Syntax bookmark-save <NUMBER>
5140 \begin_layout Description
5141 Params <NUMBER>: the number of the bookmark to save.
5144 \begin_layout Description
5145 Origin Dekel, 27 January 2001
5148 \begin_layout Subsection*
5152 \begin_layout Description
5153 Action Clears the list of saved bookmarks.
5156 \begin_layout Description
5157 Syntax bookmark-clear
5160 \begin_layout Description
5161 Origin bpeng, 31 October 2006
5164 \begin_layout Subsection*
5168 \begin_layout Description
5169 Action Open the given help file according to the language setting.
5172 \begin_layout Description
5173 Syntax help-open <FILE>[.lyx]
5176 \begin_layout Description
5177 Params <FILE>: any document from (/usr/share/)doc directory.
5180 \begin_layout Description
5181 Origin Jug, 27 Jun 1999
5184 \begin_layout Subsection*
5188 \begin_layout Description
5189 Action Terminates the current LyX instance.
5192 \begin_layout Description
5193 Notion Terminates the current LyX instance, asking whether to save modified
5197 \begin_layout Description
5201 \begin_layout Subsection*
5205 \begin_layout Description
5206 Action Toggles visibility of a given toolbar between on/off/auto.
5209 \begin_layout Description
5210 Notion Skipping "auto" when allowauto is false.
5213 \begin_layout Description
5214 Syntax toolbar-toggle <NAME> [allowauto]
5217 \begin_layout Description
5218 Params <NAME>: standard|extra|table|math|mathmacrotemplate|
5219 \begin_inset Newline newline
5222 minibuffer|review|view/update|math_panels|vcs| view-others|update-others
5225 \begin_layout Description
5226 Origin Edwin, 21 May 2007
5229 \begin_layout Subsection*
5233 \begin_layout Description
5234 Action Opens the menu given by its name.
5237 \begin_layout Description
5238 Syntax menu-open <NAME>
5241 \begin_layout Description
5242 Params <NAME>: menu name.
5243 See various .inc files in lib/ui for candidates.
5246 \begin_layout Subsection*
5250 \begin_layout Description
5251 Action Various UI visibility-toggling actions.
5254 \begin_layout Description
5255 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
5258 \begin_layout Description
5259 Params statusbar : Toggle visibility of the statusbar.
5260 \begin_inset Newline newline
5263 menubar : Toggle visibility of the menubar.
5264 \begin_inset Newline newline
5267 scrollbar : Toggle visibility of the scrollbar.
5268 \begin_inset Newline newline
5271 frame : Toggle visibility of the frames around editing window.
5272 \begin_inset Newline newline
5275 fullscreen : Toggle fullscreen mode.
5276 This also covers calling the previous functions.
5277 However LFUN_TOOLBAR_TOGGLE for the custom tweaks of the toolbars should
5281 \begin_layout Description
5282 Origin sanda, 9 Feb 2007
5285 \begin_layout Subsection*
5289 \begin_layout Description
5290 Action Creates new empty LyX window.
5293 \begin_layout Description
5294 Notion Already opened documents from the previous window can be found under
5298 \begin_layout Description
5299 Syntax window-new [<GEOMETRY>]
5302 \begin_layout Description
5303 Params <GEOMETRY>: pass the geometry of the window.
5304 This parameter is currently accepted only on Windows platform.
5307 \begin_layout Description
5308 Origin Abdel, 21 Oct 2006
5311 \begin_layout Subsection*
5315 \begin_layout Description
5316 Action Closes the current LyX window.
5319 \begin_layout Description
5323 \begin_layout Description
5324 Origin Abdel, 23 Oct 2006
5327 \begin_layout Subsection*
5331 \begin_layout Description
5332 Action Creates another split view of current buffer.
5335 \begin_layout Description
5336 Notion All split views act in the same way independently.
5339 \begin_layout Description
5340 Syntax view-split <vertical|horizontal>
5343 \begin_layout Description
5344 Params horizontal : The work areas are laid out side by side.
5345 \begin_inset Newline newline
5348 vertical : The work areas laid out vertically.
5351 \begin_layout Description
5352 Origin Abdel, 20 Feb 2008
5355 \begin_layout Subsection*
5359 \begin_layout Description
5360 Action Close the current document work area.
5363 \begin_layout Description
5364 Notion Close the current work area.
5365 If no other work areas are showing the buffer, then close the associated
5369 \begin_layout Description
5373 \begin_layout Description
5374 Origin Tommaso, 15 Sep 2012
5377 \begin_layout Subsection*
5378 LFUN_TAB_GROUP_CLOSE
5381 \begin_layout Description
5382 Action Close the current tab group.
5385 \begin_layout Description
5386 Notion This only closes the work areas, not the buffers themselves.
5387 The still opened buffers can be visualized in another tab group.
5390 \begin_layout Description
5391 Syntax tab-group-close
5394 \begin_layout Description
5395 Origin Abdel, 21 Feb 2008
5398 \begin_layout Subsection*
5402 \begin_layout Description
5403 Action Shows hidden dialog or creates new one for a given function/inset
5407 \begin_layout Description
5408 Syntax dialog-show <NAME> [<DATA>]
5411 \begin_layout Description
5412 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
5413 \begin_inset Newline newline
5416 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|
5417 \begin_inset Newline newline
5420 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimit
5422 \begin_inset Newline newline
5425 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|
5426 \begin_inset Newline newline
5429 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|
5430 \begin_inset Newline newline
5433 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL>
5434 \begin_inset Newline newline
5437 <SPECIAL>: latexlog|vclog
5438 \begin_inset Newline newline
5441 <DATA>: data, usually settings for the given dialog.
5442 Use debug mode for the details.
5445 \begin_layout Description
5446 Origin leeming, 17 Jun 2003
5449 \begin_layout Subsection*
5450 LFUN_DIALOG_SHOW_NEW_INSET
5453 \begin_layout Description
5454 Action Shows hidden dialog or create new one for a given inset settings
5458 \begin_layout Description
5459 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given
5463 \begin_layout Description
5464 Syntax dialog-show-new-inset <NAME> [<DATA>]
5467 \begin_layout Description
5468 Params See LFUN_DIALOG_SHOW .
5471 \begin_layout Description
5472 Origin leeming, 25 Feb 2003
5475 \begin_layout Subsection*
5479 \begin_layout Description
5480 Action Updates the dialog values from the inset/paragraph/document.
5483 \begin_layout Description
5484 Syntax dialog-update <NAME>
5487 \begin_layout Description
5488 Params <NAME>: paragraph|prefs|<INSET>
5489 \begin_inset Newline newline
5495 \begin_layout Description
5496 Origin leeming, 25 Feb 2003
5499 \begin_layout Subsection*
5503 \begin_layout Description
5504 Action Hides showed dialog.
5505 Counterpart to LFUN_DIALOG_SHOW .
5508 \begin_layout Description
5509 Syntax dialog-hide <NAME>
5512 \begin_layout Description
5513 Params See LFUN_DIALOG_SHOW .
5516 \begin_layout Description
5517 Origin leeming, 25 Feb 2003
5520 \begin_layout Subsection*
5524 \begin_layout Description
5525 Action Toggles dialog between showed/hidden state.
5528 \begin_layout Description
5529 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
5532 \begin_layout Description
5533 Syntax dialog-toggle <NAME> [<DATA>]
5536 \begin_layout Description
5537 Params See LFUN_DIALOG_SHOW .
5540 \begin_layout Description
5541 Origin JSpitzm, 30 Apr 2007
5544 \begin_layout Subsection*
5545 LFUN_DIALOG_DISCONNECT_INSET
5548 \begin_layout Description
5549 Action Closes opened connection to opened inset.
5552 \begin_layout Description
5553 Notion Connection is used for apply functions.
5556 \begin_layout Description
5557 Syntax dialog-disconnect-inset <INSET-NAME>
5560 \begin_layout Description
5561 Origin leeming, 25 Feb 2003
5564 \begin_layout Subsection*
5568 \begin_layout Description
5569 Action This function is called when mouse button is pressed (inside workarea).
5570 Action depends on the context.
5573 \begin_layout Description
5574 Notion This is an internal LFUN, not to be used by users.
5577 \begin_layout Description
5578 Origin Andre, 9 Aug 2002
5581 \begin_layout Subsection*
5585 \begin_layout Description
5586 Action This function is called when double click on mouse button is pressed
5588 Action depends on the context.
5591 \begin_layout Description
5592 Notion This is an internal LFUN, not to be used by users.
5595 \begin_layout Description
5596 Origin Andre, 9 Aug 2002
5599 \begin_layout Subsection*
5603 \begin_layout Description
5604 Action This function is called when triple click on mouse button is pressed
5606 Action depends on the context.
5609 \begin_layout Description
5610 Notion This is an internal LFUN, not to be used by users.
5613 \begin_layout Description
5614 Origin Andre, 9 Aug 2002
5617 \begin_layout Subsection*
5621 \begin_layout Description
5622 Action This function is called when mouse cursor is moving over the text.
5623 Action depends on the context.
5626 \begin_layout Description
5627 Notion This is an internal LFUN, not to be used by users.
5630 \begin_layout Description
5631 Origin Andre, 9 Aug 2002
5634 \begin_layout Subsection*
5638 \begin_layout Description
5639 Action This function is called when mouse button is released (inside workarea).
5640 Action depends on the context.
5643 \begin_layout Description
5644 Notion This is an internal LFUN, not to be used by users.
5647 \begin_layout Description
5648 Origin Andre, 9 Aug 2002
5651 \begin_layout Subsection*
5655 \begin_layout Description
5656 Action Turn off the loaded keyboard map.
5659 \begin_layout Description
5663 \begin_layout Subsection*
5667 \begin_layout Description
5668 Action Turn on the primary keyboard map.
5671 \begin_layout Description
5672 Notion Maps were widely used in past, when X-windows didn't have nowadays
5674 They can be still used to maintain uniform keyboard layout across the various
5676 \begin_inset Newline newline
5679 The language is to be set in the Preferences dialog.
5682 \begin_layout Description
5683 Syntax keymap-primary
5686 \begin_layout Subsection*
5687 LFUN_KEYMAP_SECONDARY
5690 \begin_layout Description
5691 Action Turn on the secondary keyboard map.
5694 \begin_layout Description
5695 Syntax keymap-secondary
5698 \begin_layout Subsection*
5702 \begin_layout Description
5703 Action Toggles keyboard maps (first/second/off).
5706 \begin_layout Description
5707 Syntax keymap-toggle
5710 \begin_layout Description
5711 Origin leeming, 30 Mar 2004
5714 \begin_layout Subsection*
5715 LFUN_SERVER_GET_LAYOUT
5718 \begin_layout Description
5719 Action Returns the current layout (that is environment) name on the cursor
5723 \begin_layout Description
5724 Syntax server-get-layout
5727 \begin_layout Subsection*
5728 LFUN_SERVER_GET_FILENAME
5731 \begin_layout Description
5732 Action Returns path and file name of the currently edited document.
5735 \begin_layout Description
5736 Syntax server-get-filename
5739 \begin_layout Subsection*
5740 LFUN_SERVER_GOTO_FILE_ROW
5743 \begin_layout Description
5744 Action Sets the cursor position in LyX based on the row number of generated
5748 \begin_layout Description
5749 Notion This can be useful for DVI inverse-search or detection of the problematic
5750 line from LaTeX compilation.
5751 Note that before this function can be used export to LaTeX output must
5752 occur (in order to map the row numbers).
5755 \begin_layout Description
5756 Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
5759 \begin_layout Description
5760 Params <FILE>: the path and filename.
5761 Environment variables are expanded in the path.
5762 In case this LFUN does not work make sure you are giving correct path to
5764 \begin_inset Newline newline
5767 If the file is located inside LyX temporary directory it will be mapped
5768 back into the appropriate opened buffer (e.g.
5769 for the case of generated .tex file).
5770 \begin_inset Newline newline
5773 .ext: extensions will be automatically replaced by .lyx.
5774 \begin_inset Newline newline
5777 <ROW_NUMBER> The row number of the LaTeX file to which to go.
5780 \begin_layout Description
5781 Sample server-goto-file-row /home/user/example.lyx 41
5782 \begin_inset Newline newline
5785 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
5788 \begin_layout Description
5789 Origin Edmar, 23 Dec 1998
5792 \begin_layout Subsection*
5796 \begin_layout Description
5797 Action Sets the cursor position in the previewed (dvi/pdf) file based on
5798 the row number in LyX window.
5801 \begin_layout Description
5802 Notion The external program used for forward search call can be specified
5803 in LyX Output preferences.
5804 See Additional manual for details of these settings.
5807 \begin_layout Description
5808 Syntax forward-search
5811 \begin_layout Description
5812 Origin sanda, 14 Apr 2010
5815 \begin_layout Subsection*
5819 \begin_layout Description
5820 Action Sends notify message about the last key-sequence to client.
5823 \begin_layout Description
5824 Notion This can be used to grab last key-sequence used inside the LyX window.
5825 See also Debug extensions section in Additional features manual.
5828 \begin_layout Description
5829 Syntax server-notify
5832 \begin_layout Subsection*
5836 \begin_layout Description
5837 Action Sets the cursor position based on the editing area coordinates (similar
5838 to clicking on that point with left mouse button).
5841 \begin_layout Description
5842 Syntax server-set-xy <X> <Y>
5845 \begin_layout Subsection*
5849 \begin_layout Description
5850 Action Returns the coordinates of cursor position in the editing area.
5853 \begin_layout Description
5854 Syntax server-get-xy
5857 \begin_layout Subsection*
5861 \begin_layout Description
5862 Action Generates the code (literate programming).
5865 \begin_layout Description
5866 Notion Latex file with extension
5868 literate_extension is generated.
5871 build_command (with a default of ``make'') to generate the code and
5873 build_error_filter to process the compilation error messages.
5874 \begin_inset Newline newline
5877 In case you want to process your literate file with a script, or some other
5878 program, just insert in your lyxrc file an entry with:
5879 \begin_inset Newline newline
5884 build_command "my_script my_arguments"
5885 \begin_inset Newline newline
5890 build_error_filter differs from the
5892 literate_error_filter only in that the former will identify error messages
5896 \begin_layout Description
5897 Syntax build-program
5900 \begin_layout Subsection*
5901 LFUN_BUFFER_AUTO_SAVE
5904 \begin_layout Description
5905 Action Saves the current buffer to a temporary file.
5908 \begin_layout Description
5909 Notion Saves the current buffer to a file named "#filename#".
5910 This LFUN is called automatically by LyX, to "autosave" the current buffer.
5913 \begin_layout Description
5914 Syntax buffer-auto-save
5917 \begin_layout Subsection*
5918 LFUN_BUFFER_CHILD_OPEN
5921 \begin_layout Description
5922 Action Loads the given child document.
5925 \begin_layout Description
5926 Notion The current document is treated as a parent.
5929 \begin_layout Description
5930 Syntax buffer-child-open <FILE>
5933 \begin_layout Description
5934 Params <FILE>: Filename of the child.
5935 The directory of the parent is assumed by default.
5938 \begin_layout Description
5939 Origin Ale, 28 May 1997
5942 \begin_layout Subsection*
5946 \begin_layout Description
5947 Action Runs chktex for the current document.
5950 \begin_layout Description
5951 Syntax buffer-chktex
5954 \begin_layout Description
5955 Origin Asger, 30 Oct 1997
5958 \begin_layout Subsection*
5959 LFUN_BUFFER_TOGGLE_COMPRESSION
5962 \begin_layout Description
5963 Action Toggles compression of the current document on/off.
5966 \begin_layout Description
5967 Syntax buffer-toggle-compression
5970 \begin_layout Description
5971 Origin bpeng, 27 Apr 2006
5974 \begin_layout Subsection*
5975 LFUN_BUFFER_TOGGLE_OUTPUT_SYNC
5978 \begin_layout Description
5979 Action Toggles including of resources for forward/reverse search of the
5983 \begin_layout Description
5984 Notion When toggled on, SyncTeX is invoked for PDF, while srcltx package
5986 Custom LaTeX macro can be defined in preferences.
5989 \begin_layout Description
5990 Syntax buffer-toggle-output-sync
5993 \begin_layout Description
5994 Origin sanda, 25 May 2010
5997 \begin_layout Subsection*
6001 \begin_layout Description
6002 Action Closes the current buffer.
6005 \begin_layout Description
6006 Notion Closes the current buffer, asking whether to save it, etc, if the
6007 buffer has been modified.
6010 \begin_layout Description
6014 \begin_layout Subsection*
6015 LFUN_BUFFER_CLOSE_ALL
6018 \begin_layout Description
6019 Action Closes all buffers.
6022 \begin_layout Description
6023 Notion Closes all buffers, asking whether to save it, etc, if a buffer has
6027 \begin_layout Description
6028 Syntax buffer-close-all
6031 \begin_layout Subsection*
6035 \begin_layout Description
6036 Action Exports the current buffer (document) to the given format.
6039 \begin_layout Description
6040 Syntax buffer-export <FORMAT> [<DEST>]
6043 \begin_layout Description
6044 Params <FORMAT> is either "custom" or one of the formats which you can find
6045 in Tools->Preferences->File formats->Format.
6046 Usual format you will enter is "pdf2" (pdflatex), "pdflatex" (plain tex
6047 for pdflatex) or "ps" for postscript.
6048 \begin_inset Newline newline
6051 In case of "custom" you will be asked for a format you want to start from
6052 and for the command that you want to apply to this format.
6053 Internally the control is then passed to LFUN_BUFFER_EXPORT_CUSTOM.
6054 <DEST> If present, this argument provides the export destination filename.
6055 Its containing folder will also be the destination folder, where all
6056 the needed external files will be copied.
6059 \begin_layout Description
6060 Origin Lgb, 29 Jul 1997
6063 \begin_layout Subsection*
6064 LFUN_BUFFER_EXPORT_CUSTOM
6067 \begin_layout Description
6068 Action Exports the current buffer (document) from the given format using
6069 the given command on it.
6072 \begin_layout Description
6073 Syntax buffer-export-custom <FORMAT> <COMMAND>
6076 \begin_layout Description
6077 Params <FORMAT> format to start from (LyX will care to produce such intermediate
6079 \begin_inset Newline newline
6082 <COMMAND> this command will be launched on the file.
6083 Note that you can use "$$FName" string to qualify the intermediate file.
6086 \begin_layout Description
6087 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
6090 \begin_layout Description
6091 Origin leeming, 27 Mar 2004
6094 \begin_layout Subsection*
6095 LFUN_BUFFER_EXPORT_AS
6098 \begin_layout Description
6099 Action Pops up a dialog for exporting the current buffer.
6102 \begin_layout Description
6103 Syntax buffer-export-as
6106 \begin_layout Description
6107 Origin tommaso, 6 Oct 2011
6110 \begin_layout Subsection*
6114 \begin_layout Description
6115 Action Prints the current document.
6118 \begin_layout Description
6119 Notion Many settings can be given via the preferences dialog.
6122 \begin_layout Description
6123 Syntax buffer-print <TARGET> <TARGET-NAME> <COMMAND>
6126 \begin_layout Description
6127 Params <TARGET> is either "printer" or "file".
6128 \begin_inset Newline newline
6131 <TARGER-NAME> is either "default" or file name or printer name.
6132 \begin_inset Newline newline
6135 <COMMAND> command ensuring the printing job.
6138 \begin_layout Description
6139 Sample buffer-print file "/trash/newfile1.ps" "dvips"
6142 \begin_layout Description
6143 Origin leeming, 28 Mar 2004
6146 \begin_layout Subsection*
6150 \begin_layout Description
6151 Action Import a given file as a lyx document.
6154 \begin_layout Description
6155 Notion File can be imported iff lyx file format is (transitively) reachable
6156 via defined converters in preferences.
6157 Look in the File->Import menu to get an idea of the currently active import
6161 \begin_layout Description
6162 Syntax buffer-import <FORMAT> [<FILE>]
6165 \begin_layout Description
6166 Origin Asger, 24 Jul 1998
6169 \begin_layout Subsection*
6173 \begin_layout Description
6174 Action Creates a new buffer (that is, document) and switches to it.
6177 \begin_layout Description
6178 Notion Implicit path can be set in Preferences dialog.
6181 \begin_layout Description
6182 Syntax buffer-new [<FILE>]
6185 \begin_layout Description
6186 Params <FILE>: filename of created file with absolute path.
6189 \begin_layout Subsection*
6190 LFUN_BUFFER_NEW_TEMPLATE
6193 \begin_layout Description
6194 Action Creates a new buffer (that is, document) from a template.
6197 \begin_layout Description
6198 Notion Path for new files and templates can be set in Preferences dialog.
6199 Template will be asked for via Open-dialog.
6202 \begin_layout Description
6203 Syntax buffer-new-template [<FILE>]
6206 \begin_layout Description
6207 Params <FILE>: filename of created file with absolute path.
6210 \begin_layout Subsection*
6214 \begin_layout Description
6215 Action Reverts opened document.
6218 \begin_layout Description
6219 Syntax buffer-reload
6222 \begin_layout Description
6223 Origin Asger, 2 Feb 1997
6226 \begin_layout Subsection*
6230 \begin_layout Description
6231 Action Display and switch to the given buffer.
6234 \begin_layout Description
6235 Syntax buffer-switch <BUFFER>
6238 \begin_layout Description
6239 Params <BUFFER>: path and filename of already opened (but possibly hidden)
6240 document which is to be shown.
6243 \begin_layout Subsection*
6244 LFUN_BUFFER_TOGGLE_READ_ONLY
6247 \begin_layout Description
6248 Action Toggle editing mode of the current document between read/write and
6252 \begin_layout Description
6253 Notion This function is not allowed if the file is under version control,
6254 since read-only flag is often used in version control file locking.
6257 \begin_layout Description
6258 Syntax buffer-toggle-read-only
6261 \begin_layout Description
6262 Origin Lgb, 27 May 1997
6265 \begin_layout Subsection*
6269 \begin_layout Description
6270 Action Displays current buffer in chosen format.
6273 \begin_layout Description
6274 Notion Displays the contents of the current buffer in the chosen format,
6275 for example, PDF or DVI.
6276 This runs the necessary converter, calls the defined viewer, and so forth.
6279 \begin_layout Description
6280 Syntax buffer-view [<FORMAT>]
6283 \begin_layout Description
6284 Params <FORMAT>: The format to display, where this is one of the formats
6285 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
6286 If no format is given, the default format as specified in the same dialog
6290 \begin_layout Subsection*
6294 \begin_layout Description
6295 Action Exports the current document and put the result into the temporary
6299 \begin_layout Description
6300 Notion In case you are already viewing the exported document (see LFUN_BUFFER_VI
6301 EW) the output will be rewritten - updated.
6302 This is useful in case your viewer is able to detect such changes (e.g.
6303 ghostview for postscript).
6306 \begin_layout Description
6307 Syntax buffer-update [<FORMAT>]
6310 \begin_layout Description
6311 Params <FORMAT>: The format to display, where this is one of the formats
6312 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
6313 If no format is given, the default format as specified in the same dialog
6317 \begin_layout Description
6318 Origin Dekel, 5 Aug 2000
6321 \begin_layout Subsection*
6325 \begin_layout Description
6326 Action Saves the current buffer.
6329 \begin_layout Description
6330 Notion Saves the current buffer to disk, using the filename that is already
6331 associated with the buffer, asking for one if none is yet assigned.
6334 \begin_layout Description
6338 \begin_layout Subsection*
6339 LFUN_BUFFER_WRITE_AS
6342 \begin_layout Description
6343 Action Rename and save current buffer.
6346 \begin_layout Description
6347 Syntax buffer-write-as <FILENAME>
6350 \begin_layout Description
6351 Params <FILENAME>: New name of the buffer/file.
6352 A relative path is with respect to the original location of the buffer/file.
6355 \begin_layout Subsection*
6359 \begin_layout Description
6360 Action Applies a command to all non-hidden buffers.
6363 \begin_layout Description
6364 Notion a buffer is `hidden' if it is internally open in LyX, but not visible
6368 \begin_layout Description
6369 Syntax buffer-forall <LFUN-COMMAND>
6372 \begin_layout Description
6373 Params <LFUN-COMMAND>: The command to be applied to the buffers.
6376 \begin_layout Description
6377 Sample Close all Notes in buffers:
6378 \begin_inset Newline newline
6381 buffer-forall inset-forall Note inset-toggle close
6382 \begin_inset Newline newline
6385 Toggle change tracking on buffers:
6386 \begin_inset Newline newline
6389 buffer-forall changes-track
6390 \begin_inset Newline newline
6393 Toggle read-only for buffers:
6394 \begin_inset Newline newline
6397 buffer-forall buffer-toggle-read-only
6398 \begin_inset Newline newline
6401 Show statistics for individual buffers:
6402 \begin_inset Newline newline
6405 buffer-forall statistics
6406 \begin_inset Newline newline
6409 Activate the branch named "Solutions" in buffers:
6410 \begin_inset Newline newline
6413 buffer-forall branch-activate Solutions
6414 \begin_inset Newline newline
6417 Export buffers to PDF (pdflatex):
6418 \begin_inset Newline newline
6421 buffer-forall buffer-export pdf2
6422 \begin_inset Newline newline
6428 \begin_layout Description
6429 Origin scottkostyshak, 20 Jul 2012
6432 \begin_layout Subsection*
6433 LFUN_BUFFER_WRITE_ALL
6436 \begin_layout Description
6437 Action Save all changed documents.
6440 \begin_layout Description
6441 Syntax buffer-write-all
6444 \begin_layout Description
6445 Origin rgh, gpothier 6 Aug 2007
6448 \begin_layout Subsection*
6452 \begin_layout Description
6453 Action Switch to the next opened document.
6456 \begin_layout Description
6457 Notion Note that this does not necessarily mean next in tabbar (for full
6458 list see View menu).
6461 \begin_layout Description
6465 \begin_layout Subsection*
6466 LFUN_BUFFER_PREVIOUS
6469 \begin_layout Description
6470 Action Switch to the previous opened document.
6473 \begin_layout Description
6474 Syntax buffer-previous
6477 \begin_layout Subsection*
6478 LFUN_MASTER_BUFFER_UPDATE
6481 \begin_layout Description
6482 Action When run from a child document, this updates (exports) document built
6483 from the master buffer, if available.
6486 \begin_layout Description
6487 Syntax master-buffer-update [<FORMAT>]
6490 \begin_layout Description
6491 Params <FORMAT>: The format to display, where this is one of the formats
6492 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
6493 If no format is given, the default format as specified in the same dialog
6497 \begin_layout Description
6498 Origin Tommaso, 20 Sep 2007
6501 \begin_layout Subsection*
6502 LFUN_MASTER_BUFFER_VIEW
6505 \begin_layout Description
6506 Action When run from a child document, this command shows a preview built
6507 from the master buffer, if available.
6510 \begin_layout Description
6511 Syntax master-buffer-view [<FORMAT>]
6514 \begin_layout Description
6515 Params <FORMAT>: The format to display, where this is one of the formats
6516 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
6517 If no format is given, the default format as specified in the same dialog
6521 \begin_layout Description
6522 Origin Tommaso, 20 Sep 2007
6525 \begin_layout Subsection*
6526 LFUN_BUFFER_LANGUAGE
6529 \begin_layout Description
6530 Action Set language of the current document.
6533 \begin_layout Description
6534 Syntax buffer-language <LANG>
6537 \begin_layout Description
6538 Params <LANG>: language name.
6539 See lib/languages for list.
6542 \begin_layout Description
6543 Origin leeming, 30 Mar 2004
6546 \begin_layout Subsection*
6547 LFUN_BUFFER_SAVE_AS_DEFAULT
6550 \begin_layout Description
6551 Action Save the current document settings as default.
6554 \begin_layout Description
6555 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
6558 \begin_layout Description
6559 Syntax buffer-save-as-default [<ARGS>]
6562 \begin_layout Description
6563 Params <ARGS>: contains the particular settings to be saved.
6564 They obey the syntax you can find in document header of usual .lyx file.
6567 \begin_layout Description
6568 Origin leeming, 30 Mar 2004
6571 \begin_layout Subsection*
6572 LFUN_BUFFER_PARAMS_APPLY
6575 \begin_layout Description
6576 Action Apply the given settings to the current document.
6579 \begin_layout Description
6580 Syntax buffer-params-apply [<ARGS>]
6583 \begin_layout Description
6584 Params <ARGS>: contains the particular settings to be saved.
6585 They obey the syntax you can find in document header of usual .lyx file.
6588 \begin_layout Description
6589 Origin leeming, 30 Mar 2004
6592 \begin_layout Subsection*
6596 \begin_layout Description
6597 Action Inserts another LyX file.
6600 \begin_layout Description
6601 Syntax file-insert [<FILE>]
6604 \begin_layout Description
6605 Params <FILE>: Filename to be inserted.
6608 \begin_layout Subsection*
6609 LFUN_FILE_INSERT_PLAINTEXT
6612 \begin_layout Description
6613 Action Inserts plain text file.
6616 \begin_layout Description
6617 Syntax file-insert-plaintext [<FILE>]
6620 \begin_layout Description
6621 Params <FILE>: Filename to be inserted.
6624 \begin_layout Description
6625 Origin CFO-G, 19 Nov 1997
6628 \begin_layout Subsection*
6629 LFUN_FILE_INSERT_PLAINTEXT_PARA
6632 \begin_layout Description
6633 Action Inserts plain text file as paragraph (i.e.
6637 \begin_layout Description
6638 Syntax file-insert-plaintext-para [<FILE>]
6641 \begin_layout Description
6642 Params <FILE>: Filename to be inserted.
6645 \begin_layout Description
6646 Origin Levon, 14 Feb 2001
6649 \begin_layout Subsection*
6653 \begin_layout Description
6654 Action Open LyX document.
6657 \begin_layout Description
6658 Syntax file-open [<FILE>]
6661 \begin_layout Description
6662 Params <FILE>: Filename to be opened.
6665 \begin_layout Subsection*
6669 \begin_layout Description
6670 Action Executes a command defined in a .def file.
6673 \begin_layout Description
6674 Notion The definitions are by default read from lib/commands/default.def.
6675 \begin_inset Newline newline
6678 A .def file allows to define a command with
6680 define "<NAME>" "<LFUN>" where <NAME> is the name of the new command and
6681 <LFUN> is the lfun code to be executed (see e.g.
6682 LFUN_COMMAND_SEQUENCE).
6685 def_file "FileName" allows to include another .def file.
6686 \begin_inset Newline newline
6689 This is particularly useful in connection with toolbar buttons: Since the
6690 name of the button image for this lfun is lib/images/commands/<NAME>.png
6691 this is the way to assign an image to a complex command-sequence.
6694 \begin_layout Description
6698 \begin_layout Description
6699 Params <NAME>: Name of the command that must be called.
6702 \begin_layout Description
6703 Origin broider, 2 Oct 2007
6706 \begin_layout Subsection*
6710 \begin_layout Description
6711 Action Simulate halting Meta key (Alt key on PCs).
6714 \begin_layout Description
6715 Notion Used for buffer editation not for GUI control.
6718 \begin_layout Description
6722 \begin_layout Subsection*
6726 \begin_layout Description
6727 Action Cancels sequence prepared by LFUN_META_PREFIX .
6730 \begin_layout Description
6734 \begin_layout Subsection*
6735 LFUN_COMMAND_EXECUTE
6738 \begin_layout Description
6739 Action Switches the focus to the minibuffer so that the user can type in
6741 If necessary, it opens the minibuffer toolbar.
6744 \begin_layout Description
6745 Notion Usually bound to M-x shortcut.
6748 \begin_layout Description
6749 Syntax command-execute
6752 \begin_layout Subsection*
6756 \begin_layout Description
6757 Action Return the current key sequence and available options as a string.
6760 \begin_layout Description
6761 Notion No options are added if no current map exists.
6762 \begin_inset Newline newline
6765 This is probably usable only with connection to lyxserver.
6768 \begin_layout Description
6769 Syntax command-prefix
6772 \begin_layout Subsection*
6773 LFUN_COMMAND_SEQUENCE
6776 \begin_layout Description
6777 Action Run more commands (LFUN and its parameters) in a sequence.
6780 \begin_layout Description
6781 Syntax command-sequence <CMDS>
6784 \begin_layout Description
6785 Params <CMDS>: Sequence of commands separated by semicolons.
6788 \begin_layout Description
6789 Sample command-sequence cut; ert-insert; self-insert
6791 ; paste; self-insert {}; inset-toggle;
6794 \begin_layout Description
6795 Origin Andre, 11 Nov 1999
6798 \begin_layout Subsection*
6799 LFUN_COMMAND_ALTERNATIVES
6802 \begin_layout Description
6803 Action Runs the first listed command that is enabled.
6806 \begin_layout Description
6807 Notion This can be used to bind multiple functions to a single key, and
6808 then which one is used will depend upon the context.
6811 \begin_layout Description
6812 Syntax command-alternatives <CMDS>
6815 \begin_layout Description
6816 Params <CMDS>: Sequence of commands separated by semicolons.
6819 \begin_layout Description
6820 Sample command-alternatives completion-accept;cell-forward
6823 \begin_layout Description
6824 Origin rgh, 24 September 2008
6827 \begin_layout Subsection*
6831 \begin_layout Description
6832 Action Shows message in statusbar (for script purposes).
6835 \begin_layout Description
6836 Syntax message <STRING>
6839 \begin_layout Description
6840 Origin Lgb, 8 Apr 2001
6843 \begin_layout Subsection*
6844 LFUN_DEBUG_LEVEL_SET
6847 \begin_layout Description
6848 Action Set debug output level.
6851 \begin_layout Description
6852 Syntax debug-level-set <LEVEL>
6855 \begin_layout Description
6856 Params <LEVEL>: comma separated list of levels or the correspondent number
6857 of their combination.
6858 0 is equivalent to disabling all debug events.
6859 See lyx -dbg for the current list of debug levels and their numbers.
6862 \begin_layout Description
6863 Origin sanda, 28 Dec 2009
6866 \begin_layout Subsection*
6867 LFUN_PREFERENCES_SAVE
6870 \begin_layout Description
6871 Action Save user preferences.
6874 \begin_layout Description
6875 Syntax preferences-save
6878 \begin_layout Description
6879 Origin Lgb, 27 Nov 1999
6882 \begin_layout Subsection*
6886 \begin_layout Description
6887 Action Reconfigure the automatic settings.
6890 \begin_layout Description
6894 \begin_layout Description
6895 Origin Asger, 14 Feb 1997
6898 \begin_layout Subsection*
6902 \begin_layout Description
6903 Action Apply the given settings to user preferences.
6906 \begin_layout Description
6907 Syntax lyxrc-apply <SETTINGS>
6910 \begin_layout Description
6911 Params <SETTINGS>: settings which are to be set.
6912 Take a look into ~/.lyx/preferences to get an idea which commands to use
6914 lyx::LyXRC::LyXRCTags has the list of possible commands.
6917 \begin_layout Subsection*
6918 LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
6921 \begin_layout Description
6922 Action Determine whether to keep cursor inside the editing window regardless
6923 of the scrollbar movement.
6926 \begin_layout Description
6927 Syntax toggle-cursor-follows-scrollbar
6930 \begin_layout Description
6931 Origin ARRae, 2 Dec 1997
6934 \begin_layout Subsection*
6938 \begin_layout Description
6939 Action Set the given LyX color to the color defined by the X11 name given.
6942 \begin_layout Description
6943 Notion A new color entry is created if the color is unknown.
6944 Color names can be stored as a part of user settings.
6947 \begin_layout Description
6948 Syntax set-color <LYX_NAME> <X11_NAME>
6951 \begin_layout Description
6952 Origin SLior, 11 Jun 2000
6955 \begin_layout Subsection*
6959 \begin_layout Description
6960 Action Count the statistics (number of words and characters) in the document
6961 or in the given selection.
6964 \begin_layout Description
6965 Notion Note that this function gives the number of words/chars written,
6966 not the number of characters which will be typeset.
6969 \begin_layout Description
6973 \begin_layout Description
6974 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
6977 \begin_layout Subsection*
6978 LFUN_COMPLETION_INLINE
6981 \begin_layout Description
6982 Action Show the inline completion at the cursor position.
6985 \begin_layout Description
6986 Syntax completion-inline
6989 \begin_layout Description
6990 Origin sts, Feb 19 2008
6993 \begin_layout Subsection*
6994 LFUN_COMPLETION_POPUP
6997 \begin_layout Description
6998 Action Show the completion popup at the cursor position.
7001 \begin_layout Description
7002 Syntax completion-popup
7005 \begin_layout Description
7006 Origin sts, Feb 19 2008
7009 \begin_layout Subsection*
7010 LFUN_COMPLETION_COMPLETE
7013 \begin_layout Description
7014 Action Try to complete the word or command at the cursor position.
7017 \begin_layout Description
7021 \begin_layout Description
7022 Origin sts, Feb 19 2008
7025 \begin_layout Subsection*
7026 LFUN_COMPLETION_CANCEL
7029 \begin_layout Description
7030 Action Try to cancel completion, either the popup or the inline completion.
7033 \begin_layout Description
7034 Syntax completion-cancel
7037 \begin_layout Description
7038 Origin sts, Sep 07 2008
7041 \begin_layout Subsection*
7042 LFUN_COMPLETION_ACCEPT
7045 \begin_layout Description
7046 Action Accept suggested completion.
7049 \begin_layout Description
7050 Syntax completion-accept
7053 \begin_layout Description
7054 Origin sanda, Sep 08 2008
7057 \begin_layout Subsection*
7061 \begin_layout Description
7062 Action Add a branch to the buffer's BranchList.
7065 \begin_layout Description
7066 Syntax branch-add <BRANCH>
7069 \begin_layout Description
7070 Params <BRANCH>: Name of the branch to add
7073 \begin_layout Description
7074 Origin spitz, 7 Jul 2009
7077 \begin_layout Subsection*
7078 LFUN_BRANCH_ACTIVATE
7081 \begin_layout Description
7082 Action Activate the branch.
7085 \begin_layout Description
7086 Syntax branch-activate <BRANCH>
7089 \begin_layout Description
7090 Params <BRANCH>: The branch to activate
7093 \begin_layout Description
7094 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
7095 \begin_inset Newline newline
7098 could be used to export a pdf with the answers branch included without one's
7099 having to open LyX and activate the branch manually.
7102 \begin_layout Description
7103 Origin rgh, 27 May 2008
7106 \begin_layout Subsection*
7107 LFUN_BRANCH_DEACTIVATE
7110 \begin_layout Description
7111 Action De-activate the branch.
7114 \begin_layout Description
7115 Syntax branch-deactivate <BRANCH>
7118 \begin_layout Description
7119 Params <BRANCH>: The branch to deactivate
7122 \begin_layout Description
7123 Origin rgh, 27 May 2008
7126 \begin_layout Subsection*
7127 LFUN_BRANCH_MASTER_ACTIVATE
7130 \begin_layout Description
7131 Action Activate the branch in the master buffer.
7134 \begin_layout Description
7135 Syntax branch-master-activate <BRANCH>
7138 \begin_layout Description
7139 Params <BRANCH>: The branch to activate
7142 \begin_layout Description
7143 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
7144 \begin_inset Newline newline
7147 could be used to export a pdf with the answers branch included without one's
7148 having to open LyX and activate the branch manually.
7151 \begin_layout Description
7152 Origin spitz, 30 Sep 2012
7155 \begin_layout Subsection*
7156 LFUN_BRANCH_MASTER_DEACTIVATE
7159 \begin_layout Description
7160 Action De-activate the branch in the master buffer.
7163 \begin_layout Description
7164 Syntax branch-master-deactivate <BRANCH>
7167 \begin_layout Description
7168 Params <BRANCH>: The branch to deactivate
7171 \begin_layout Description
7172 Origin spitz, 30 Sep 2012
7175 \begin_layout Subsection*
7176 LFUN_BRANCHES_RENAME
7179 \begin_layout Description
7180 Action Rename all branches of a given name in a document.
7183 \begin_layout Description
7184 Syntax branches-rename <OLDNAME> <NEWNAME>
7187 \begin_layout Description
7188 Params <OLDNAME>: Current name of the branch to be renamed <NEWNAME>: New
7192 \begin_layout Description
7193 Origin spitz, 9 Jul 2009
7196 \begin_layout Subsection*
7197 LFUN_BRANCH_ADD_INSERT
7200 \begin_layout Description
7201 Action Create new branch and directly put the branch inset into the document.
7204 \begin_layout Description
7205 Syntax branch-add-insert [<NAME>]
7208 \begin_layout Description
7209 Params <NAME>: Branch name.
7210 If it is not specified, you will be asked.
7213 \begin_layout Description
7214 Origin sanda, 10 Jul 2009
7217 \begin_layout Subsection*
7218 LFUN_LABEL_COPY_AS_REF
7221 \begin_layout Description
7222 Action Copies the label at the cursor as a cross-reference to be pasted
7226 \begin_layout Description
7227 Syntax copy-label-as-reference <LABEL>
7230 \begin_layout Description
7231 Params <LABEL>: The label to copy (for multi-line math)
7234 \begin_layout Description
7235 Origin sts, 16 Nov 2008
7238 \begin_layout Subsection*
7239 LFUN_LABEL_INSERT_AS_REF
7242 \begin_layout Description
7243 Action Inserts the label (in ToC pane) as a cross-reference at the position
7247 \begin_layout Description
7248 Syntax label-insert-as-reference
7251 \begin_layout Description
7252 Origin vfr, 7 Apr 2009
7255 \begin_layout Subsection*
7259 \begin_layout Description
7260 Action Increases the zoom of the screen fonts.
7263 \begin_layout Description
7264 Syntax buffer-zoom-in [<ZOOM>]
7267 \begin_layout Description
7268 Params <ZOOM>: The zoom in %, the default is 20.
7271 \begin_layout Description
7272 Origin vfr, 30 Mar 2009
7275 \begin_layout Subsection*
7276 LFUN_BUFFER_ZOOM_OUT
7279 \begin_layout Description
7280 Action Decreases the zoom of the screen fonts.
7283 \begin_layout Description
7284 Syntax buffer-zoom-out [<ZOOM>]
7287 \begin_layout Description
7288 Params <ZOOM>: The zoom in %, the default is 20.
7291 \begin_layout Description
7292 Origin vfr, 30 Mar 2009
7295 \begin_layout Subsection*
7299 \begin_layout Description
7300 Action Copies the inset to the clipboard as a certain type.
7303 \begin_layout Description
7304 Notion Currently used only for InsetInfo where its content is copied as
7308 \begin_layout Description
7309 Syntax inset-copy-as
7312 \begin_layout Description
7313 Origin vfr, 18 Apr 2010
7316 \begin_layout Subsection*
7317 LFUN_ENVIRONMENT_SPLIT
7320 \begin_layout Description
7321 Action Splits the current environment with a Separator.
7324 \begin_layout Description
7325 Syntax environment-split
7328 \begin_layout Description
7329 Origin spitz, 23 Dec 2012