1 # gen_lfuns.py generated this file. For more info see http://www.lyx.org/
5 \origin /systemlyxdir/doc/
8 \renewcommand{\descriptionlabel}[1]{\hspace\labelsep\upshape\bfseries #1:}
9 \renewenvironment{description}{\list{}{%
10 \setlength{\itemsep}{-2pt}
11 \advance\leftmargini6\p@ \itemindent-12\p@
12 \labelwidth\z@ \let\makelabel\descriptionlabel}%
17 \use_default_options false
18 \maintain_unincluded_children false
26 \language_package default
29 \font_roman "default" "default"
30 \font_sans "default" "default"
31 \font_typewriter "default" "default"
32 \font_math "auto" "auto"
33 \font_default_family default
34 \use_non_tex_fonts false
37 \font_sf_scale 100 100
38 \font_tt_scale 100 100
40 \default_output_format default
42 \bibtex_command default
43 \index_command default
44 \paperfontsize default
49 \use_package amsmath 1
50 \use_package amssymb 1
53 \use_package mathdots 0
54 \use_package mathtools 0
56 \use_package stackrel 0
57 \use_package stmaryrd 0
58 \use_package undertilde 0
60 \cite_engine_type default
64 \paperorientation portrait
78 \paragraph_separation indent
79 \paragraph_indentation default
80 \quotes_language english
83 \paperpagestyle default
84 \tracking_changes false
107 \begin_layout Section*
111 \begin_layout Standard
112 This manual documents the
113 \begin_inset Quotes eld
117 \begin_inset Quotes erd
121 These are commands that are used to make \SpecialChar LyX
122 perform specific actions.
124 itself uses these functions internally, and every internal action is
128 \begin_layout Standard
129 LFUNs are also used in the files that define keyboard shortcuts, menu or
131 So if you want to change\SpecialChar breakableslash
132 customize the user interface, you need to deal
134 Furthermore, external programs can use LFUNs to communicate with and
135 \begin_inset Quotes eld
139 \begin_inset Quotes erd
144 Finally, you can also issue LFUNs directly via the so called mini-buffer
145 which can be opened via
148 arg "command-execute"
154 \begin_layout Standard
155 In the following, all LFUNs are listed, categorized by function.
158 \begin_layout Section
159 Layout Functions (Font, Layout and Textclass related)
161 \begin_layout Subsection*
164 \begin_layout Description
165 Action Displays list of layout choices.
167 \begin_layout Description
168 Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox allowing for choice of layout.
170 \begin_layout Description
171 Syntax drop-layouts-choice
174 \begin_layout Subsection*
177 \begin_layout Description
178 Action Splits the current environment with a Separator.
180 \begin_layout Description
181 Syntax environment-split [outer]
183 \begin_layout Description
184 Params outer: If this is given, LyX will split the outermost environment in the current nesting hierarchy.
186 \begin_layout Description
187 Origin spitz, 23 Dec 2012
190 \begin_layout Subsection*
193 \begin_layout Description
194 Action Toggles the bold font (selection-wise) using mathbf in math.
196 \begin_layout Description
200 \begin_layout Subsection*
203 \begin_layout Description
204 Action Toggles the bold font (selection-wise) using boldsymbol in math.
206 \begin_layout Description
207 Syntax font-boldsymbol
210 \begin_layout Subsection*
213 \begin_layout Description
214 Action Reverts the settings of the font to the default values (selection-wise).
216 \begin_layout Description
220 \begin_layout Subsection*
223 \begin_layout Description
224 Action Toggles the emphasis font style (selection-wise).
226 \begin_layout Description
230 \begin_layout Subsection*
233 \begin_layout Description
234 Action Toggles Fraktur family font (math-mode, selection-wise).
236 \begin_layout Description
239 \begin_layout Description
240 Origin vermeer, 10 Jan 2002
243 \begin_layout Subsection*
246 \begin_layout Description
247 Action Toggles Italics font shape (math-mode, selection-wise).
249 \begin_layout Description
252 \begin_layout Description
253 Origin vermeer, 10 Jan 2002
256 \begin_layout Subsection*
259 \begin_layout Description
260 Action Toggles Noun text style font (selection-wise).
262 \begin_layout Description
266 \begin_layout Subsection*
269 \begin_layout Description
270 Action Toggles Roman family font (selection-wise).
272 \begin_layout Description
276 \begin_layout Subsection*
279 \begin_layout Description
280 Action Toggles Sans Serif family font (selection-wise).
282 \begin_layout Description
286 \begin_layout Subsection*
289 \begin_layout Description
290 Action Sets font size according to lyx format string.
292 \begin_layout Description
293 Syntax font-size <SIZE>
295 \begin_layout Description
296 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
297 \begin_inset Newline newline
300 largest|huge|giant|increase|decrease|default
303 \begin_layout Subsection*
306 \begin_layout Description
307 Action Returns the info about the current font.
309 \begin_layout Description
313 \begin_layout Subsection*
316 \begin_layout Description
317 Action Toggles strikeout (strike-through) in the font (selection-wise).
319 \begin_layout Description
320 Syntax font-strikeout
322 \begin_layout Description
323 Origin sanda, 3 May 2009
326 \begin_layout Subsection*
329 \begin_layout Description
330 Action Toggles the typewriter family font (selection-wise).
332 \begin_layout Description
333 Syntax font-typewriter
336 \begin_layout Subsection*
339 \begin_layout Description
340 Action Toggles underline in the font (selection-wise).
342 \begin_layout Description
343 Syntax font-underline
346 \begin_layout Subsection*
349 \begin_layout Description
350 Action Toggles double underline in the font (selection-wise).
352 \begin_layout Description
353 Syntax font-underunderline
355 \begin_layout Description
356 Origin sanda, 5 May 2009
359 \begin_layout Subsection*
362 \begin_layout Description
363 Action Toggles wavy underline in the font (selection-wise).
365 \begin_layout Description
366 Syntax font-underwave
368 \begin_layout Description
369 Origin sanda, 5 May 2009
372 \begin_layout Subsection*
375 \begin_layout Description
376 Action Sets the layout (that is, environment) for the current paragraph.
378 \begin_layout Description
379 Syntax layout <LAYOUT>
381 \begin_layout Description
382 Params <LAYOUT>: the layout to use
385 \begin_layout Subsection*
388 \begin_layout Description
389 Action Adds a module.
391 \begin_layout Description
392 Notion Adds a module to the list of included modules for the current buffer.
394 \begin_layout Description
395 Syntax layout-module-add <MODULE>
397 \begin_layout Description
398 Params <MODULE>: the module to be added
400 \begin_layout Description
401 Origin rgh, 25 August 2007
404 \begin_layout Subsection*
407 \begin_layout Description
408 Action Clears the module list.
410 \begin_layout Description
411 Notion Clears the list of included modules for the current buffer.
413 \begin_layout Description
414 Syntax layout-modules-clear
416 \begin_layout Description
417 Origin rgh, 25 August 2007
420 \begin_layout Subsection*
423 \begin_layout Description
424 Action Launches the paragraph settings dialog.
426 \begin_layout Description
427 Syntax layout-paragraph
430 \begin_layout Subsection*
433 \begin_layout Description
434 Action Reloads layout information.
436 \begin_layout Description
437 Notion Reloads all layout information for the current buffer from disk, thus recognizing any changes that have been made to layout files on the fly. This is intended to be used only by layout developers and should not be used when one is trying to do actual work.
439 \begin_layout Description
442 \begin_layout Description
443 Origin rgh, 3 September 2007
446 \begin_layout Subsection*
449 \begin_layout Description
450 Action Launches the tabular settings dialog.
452 \begin_layout Description
453 Syntax layout-tabular
455 \begin_layout Description
456 Origin Jug, 31 Jul 2000
459 \begin_layout Subsection*
462 \begin_layout Description
463 Action Update fonts and its metrics.
465 \begin_layout Description
466 Notion Automatically called after zoom, dpi, font names, or norm change.
468 \begin_layout Description
469 Syntax screen-font-update
471 \begin_layout Description
472 Origin ARRae, 13 Aug 2000
475 \begin_layout Subsection*
478 \begin_layout Description
479 Action Sets the text class for the current buffer.
481 \begin_layout Description
482 Syntax textclass-apply <TEXTCLASS>
484 \begin_layout Description
485 Params <TEXTCLASS>: the textclass to set. Note that this must be the filename, minus the ".layout" extension.
488 \begin_layout Subsection*
491 \begin_layout Description
492 Action Loads information for a textclass from disk.
494 \begin_layout Description
495 Syntax textclass-load <TEXTCLASS>
497 \begin_layout Description
498 Params <TEXTCLASS>: the textclass to load. Note that this must be the filename, minus the ".layout" extension.
501 \begin_layout Subsection*
504 \begin_layout Description
505 Action Toggle user-defined (=last-time used) text style.
507 \begin_layout Description
508 Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically triggered when using Text Style dialog.
510 \begin_layout Description
511 Syntax textstyle-apply
513 \begin_layout Description
514 Origin leeming, 12 Mar 2003
517 \begin_layout Subsection*
520 \begin_layout Description
521 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APPLY.
523 \begin_layout Description
524 Syntax textstyle-update <FONT_INFO>
526 \begin_layout Description
527 Params <FONT_INFO>: specifies font atributes, e.g. family, series, shape, size, emph, noun, underbar, number, color, language, toggleall.
528 \begin_inset Newline newline
531 Use lyx -dbg action for exact syntax of text-style dialog parameters.
533 \begin_layout Description
534 Origin leeming, 12 Mar 2003
537 \begin_layout Section
538 Editing Functions (Cursor and Mouse Movement, Copy/Paste etc.)
540 \begin_layout Subsection*
543 \begin_layout Description
544 Action Adds an acute accent to the next character typed.
546 \begin_layout Description
550 \begin_layout Subsection*
553 \begin_layout Description
554 Action Adds a breve accent to the next character typed.
556 \begin_layout Description
560 \begin_layout Subsection*
563 \begin_layout Description
564 Action Adds a caron to the next character typed.
566 \begin_layout Description
570 \begin_layout Subsection*
573 \begin_layout Description
574 Action Adds a cedilla to the next character typed.
576 \begin_layout Description
577 Syntax accent-cedilla
580 \begin_layout Subsection*
583 \begin_layout Description
584 Action Adds a circle accent to the next character typed.
586 \begin_layout Description
590 \begin_layout Subsection*
593 \begin_layout Description
594 Action Adds a circumflex to the next character typed.
596 \begin_layout Description
597 Syntax accent-circumflex
600 \begin_layout Subsection*
603 \begin_layout Description
604 Action Adds a dot accent to the next character typed.
606 \begin_layout Description
610 \begin_layout Subsection*
613 \begin_layout Description
614 Action Adds a grave accent to the next character typed.
616 \begin_layout Description
620 \begin_layout Subsection*
621 accent-hungarian-umlaut
623 \begin_layout Description
624 Action Adds a Hungarian umlaut to the next character typed.
626 \begin_layout Description
630 \begin_layout Subsection*
633 \begin_layout Description
634 Action Adds a macron to the next character typed.
636 \begin_layout Description
640 \begin_layout Subsection*
643 \begin_layout Description
644 Action Adds an ogonek accent to the next character typed.
646 \begin_layout Description
650 \begin_layout Subsection*
653 \begin_layout Description
654 Action Adds a perispomeni (Greek circumflex) over the next character typed.
656 \begin_layout Description
657 Syntax accent-perispomeni
660 \begin_layout Subsection*
663 \begin_layout Description
664 Action Adds a tie over the next two character typed.
666 \begin_layout Description
667 Notion The following char will finish the tie.
669 \begin_layout Description
673 \begin_layout Subsection*
676 \begin_layout Description
677 Action Adds a tilde over the next character typed.
679 \begin_layout Description
683 \begin_layout Subsection*
686 \begin_layout Description
687 Action Adds an umlaut over the next character typed.
689 \begin_layout Description
693 \begin_layout Subsection*
696 \begin_layout Description
697 Action Adds a bar under the next character typed.
699 \begin_layout Description
700 Syntax accent-underbar
703 \begin_layout Subsection*
706 \begin_layout Description
707 Action Adds a dot under the next character typed.
709 \begin_layout Description
710 Syntax accent-underdot
713 \begin_layout Subsection*
716 \begin_layout Description
717 Action Accepts all tracked changes in the document.
719 \begin_layout Description
720 Syntax all-changes-accept
722 \begin_layout Description
723 Origin Levon, 16 Oct 2002
726 \begin_layout Subsection*
729 \begin_layout Description
730 Action Rejects all tracked changes in the document.
732 \begin_layout Description
733 Notion Reject does not work recursively; the user may have to repeat the operation.
735 \begin_layout Description
736 Syntax all-changes-reject
738 \begin_layout Description
739 Origin Levon, 16 Oct 2002
742 \begin_layout Subsection*
745 \begin_layout Description
746 Action Start (or remove) Appendix on the given cursor position.
748 \begin_layout Description
751 \begin_layout Description
752 Origin ettrich, 5 May 1998
755 \begin_layout Subsection*
758 \begin_layout Description
759 Action Inserts an argument (short title) inset.
761 \begin_layout Description
762 Syntax argument-insert <argument nr>
764 \begin_layout Description
765 Params <argument nr>: see layout declarations
767 \begin_layout Description
768 Origin vermeer, 12 Aug 2002
771 \begin_layout Subsection*
774 \begin_layout Description
775 Action Adds database, which will be used for bibtex citations.
777 \begin_layout Description
778 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
780 \begin_layout Description
781 Syntax bibtex-database-add <DATABASE-NAME>
783 \begin_layout Description
784 Origin Ale, 30 May 1997
787 \begin_layout Subsection*
790 \begin_layout Description
791 Action Adds database, which will be used for bibtex citations.
793 \begin_layout Description
794 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
796 \begin_layout Description
797 Syntax bibtex-database-del <DATABASE-NAME>
799 \begin_layout Description
800 Origin Ale, 30 May 1997
803 \begin_layout Subsection*
806 \begin_layout Description
807 Action Clears the list of saved bookmarks.
809 \begin_layout Description
810 Syntax bookmark-clear
812 \begin_layout Description
813 Origin bpeng, 31 October 2006
816 \begin_layout Subsection*
819 \begin_layout Description
820 Action Moves the cursor to the numbered bookmark, opening the file if necessary. Note that bookmarks are saved per-session, not per file.
822 \begin_layout Description
823 Notion Bookmark 0 has a special purpose. It is automatically set
824 \begin_inset Newline newline
827 1. to the paragraph you are currently editing
828 \begin_inset Newline newline
831 2. to the paragraph from where you are jumping to the last-edited position (jump-back feature)
832 \begin_inset Newline newline
835 3. when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
837 \begin_layout Description
838 Syntax bookmark-goto <NUMBER>
840 \begin_layout Description
841 Params <NUMBER>: the number of the bookmark to restore.
843 \begin_layout Description
844 Origin Dekel, 27 January 2001
847 \begin_layout Subsection*
850 \begin_layout Description
851 Action Save a bookmark.
853 \begin_layout Description
854 Notion Saves a numbered bookmark to the sessions file. The number must be between 1 and 9, inclusive. Note that bookmarks are saved per-session, not per file.
856 \begin_layout Description
857 Syntax bookmark-save <NUMBER>
859 \begin_layout Description
860 Params <NUMBER>: the number of the bookmark to save.
862 \begin_layout Description
863 Origin Dekel, 27 January 2001
866 \begin_layout Subsection*
869 \begin_layout Description
870 Action Inserts Box inset.
872 \begin_layout Description
873 Syntax box-insert [<TYPE>]
875 \begin_layout Description
876 Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
877 \begin_inset Newline newline
880 Framed is the default one.
882 \begin_layout Description
883 Origin vermeer, 7 Oct 2003
886 \begin_layout Subsection*
889 \begin_layout Description
890 Action Inserts branch inset.
892 \begin_layout Description
893 Syntax branch-insert <BRANCH-NAME>
895 \begin_layout Description
896 Origin vermeer, 17 Aug 2003
899 \begin_layout Subsection*
902 \begin_layout Description
903 Action Move the cursor to the beginning of the document.
905 \begin_layout Description
909 \begin_layout Subsection*
912 \begin_layout Description
913 Action Move the cursor to the beginning of the document adding the traversed text to the selection.
915 \begin_layout Description
916 Syntax buffer-begin-select
919 \begin_layout Subsection*
922 \begin_layout Description
923 Action Move the cursor to the end of the document.
925 \begin_layout Description
929 \begin_layout Subsection*
932 \begin_layout Description
933 Action Move the cursor to the end of the document adding the traversed text to the selection.
935 \begin_layout Description
936 Syntax buffer-end-select
939 \begin_layout Subsection*
942 \begin_layout Description
943 Action Inserts a caption inset.
945 \begin_layout Description
946 Syntax caption-insert
948 \begin_layout Description
949 Origin Lgb, 18 Jul 2000
952 \begin_layout Subsection*
955 \begin_layout Description
956 Action Moves the cursor to the previous cell inside the table.
958 \begin_layout Description
961 \begin_layout Description
962 Origin Jug, 22 May 2000
965 \begin_layout Subsection*
968 \begin_layout Description
969 Action Moves the cursor to the next cell inside the table.
971 \begin_layout Description
975 \begin_layout Subsection*
978 \begin_layout Description
979 Action Splits cell and shifts right part to the next cell (inside the math grid).
981 \begin_layout Description
984 \begin_layout Description
985 Origin Ale, 15 May 1997
988 \begin_layout Subsection*
991 \begin_layout Description
992 Action Accepts tracked change inside the selection.
994 \begin_layout Description
997 \begin_layout Description
998 Origin Levon, 16 Oct 2002
1001 \begin_layout Subsection*
1004 \begin_layout Description
1005 Action Moves the cursor to the position of the next change of the change tracking records.
1007 \begin_layout Description
1010 \begin_layout Description
1011 Origin schmitt, 4 Oct 2006
1014 \begin_layout Subsection*
1017 \begin_layout Description
1018 Action Moves the cursor to the position of the previous change of the change tracking records.
1020 \begin_layout Description
1021 Syntax change-previous
1023 \begin_layout Description
1024 Origin vfr, 4 Apr 2009
1027 \begin_layout Subsection*
1030 \begin_layout Description
1031 Action Rejects tracked change inside the selection.
1033 \begin_layout Description
1034 Syntax change-reject
1036 \begin_layout Description
1037 Origin Levon, 16 Oct 2002
1040 \begin_layout Subsection*
1043 \begin_layout Description
1044 Action Open change tracking dialog for merging and moves the cursor to the position of the next change.
1046 \begin_layout Description
1047 Syntax changes-merge
1049 \begin_layout Description
1050 Origin Levon, 16 Oct 2002
1053 \begin_layout Subsection*
1056 \begin_layout Description
1057 Action Toggles showing of change tracking in typeset output.
1059 \begin_layout Description
1060 Syntax changes-output
1062 \begin_layout Description
1063 Origin jspitzm, 21 Jan 2005
1066 \begin_layout Subsection*
1069 \begin_layout Description
1070 Action Toggles change tracking to on/off.
1072 \begin_layout Description
1073 Syntax changes-track
1075 \begin_layout Description
1076 Origin levon, 1 Oct 2002
1079 \begin_layout Subsection*
1082 \begin_layout Description
1083 Action Moves the cursor one position logically backwards.
1085 \begin_layout Description
1086 Notion This is not the action which should be bound to the arrow keys, because backwards may be left or right, depending on the language. The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions, which in turn may employ this one.
1088 \begin_layout Description
1089 Syntax char-backward
1092 \begin_layout Subsection*
1093 char-backward-select
1095 \begin_layout Description
1096 Action Moves the cursor one position logically backwards, adding traversed position to the selection.
1098 \begin_layout Description
1099 Notion See also LFUN_CHAR_BACKWARD.
1101 \begin_layout Description
1102 Syntax char-backward-select
1105 \begin_layout Subsection*
1106 char-delete-backward
1108 \begin_layout Description
1109 Action Deletes one character in the backward direction (usually the "BackSpace" key).
1111 \begin_layout Description
1112 Syntax char-delete-backward
1115 \begin_layout Subsection*
1118 \begin_layout Description
1119 Action Deletes one character in the backward direction (usually the "Delete" key).
1121 \begin_layout Description
1122 Syntax char-delete-forward
1125 \begin_layout Subsection*
1128 \begin_layout Description
1129 Action Moves the cursor one position logically forward.
1131 \begin_layout Description
1132 Notion This is not the action which should be bound to the arrow keys, because forward may be left or right, depending on the language. The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions, which in turn may employ this one.
1134 \begin_layout Description
1138 \begin_layout Subsection*
1141 \begin_layout Description
1142 Action Moves the cursor one position logically forward, adding traversed position to the selection.
1144 \begin_layout Description
1145 Notion See also LFUN_CHAR_FORWARD.
1147 \begin_layout Description
1148 Syntax char-forward-select
1151 \begin_layout Subsection*
1154 \begin_layout Description
1155 Action Moves the cursor one position "to the left".
1157 \begin_layout Description
1158 Notion This is the action which should be taken when the "left" key is pressed. Generally, it moves the cursor one position to the left. However, in Bidi text this become slightly more complicated, and there are different modes of cursor movement. In "visual mode", this moves left, plain and simple. In "logical mode", movement is logically forward in RTL paragraphs, and logically backwards in LTR paragraphs.
1160 \begin_layout Description
1164 \begin_layout Subsection*
1167 \begin_layout Description
1168 Action Moves the cursor one position "to the left", adding traversed position to the selection.
1170 \begin_layout Description
1171 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1173 \begin_layout Description
1174 Syntax char-left-select
1177 \begin_layout Subsection*
1180 \begin_layout Description
1181 Action Moves the cursor one position "to the right".
1183 \begin_layout Description
1184 Notion This is the action which should be taken when the "right" key is pressed. Generally, it moves the cursor one position to the right. However, in Bidi text this become slightly more complicated, and there are different modes of cursor movement. In "visual mode", this moves right, plain and simple. In "logical mode", movement is logically forward in LTR paragraphs, and logically backwards in RTL paragraphs.
1186 \begin_layout Description
1190 \begin_layout Subsection*
1193 \begin_layout Description
1194 Action Moves the cursor one position "to the right", adding traversed position to the selection.
1196 \begin_layout Description
1197 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1199 \begin_layout Description
1200 Syntax char-right-select
1203 \begin_layout Subsection*
1206 \begin_layout Description
1207 Action Transposes the character at the cursor with the one before it.
1209 \begin_layout Description
1210 Syntax chars-transpose
1212 \begin_layout Description
1213 Origin Lgb, 25 Apr 2001
1216 \begin_layout Subsection*
1219 \begin_layout Description
1220 Action Inserts citation from loaded citation database.
1222 \begin_layout Description
1223 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
1225 \begin_layout Description
1226 Params <KEY>: Citation (shortcut listed in available citations).
1227 \begin_inset Newline newline
1230 <TEXT_BEFORE>: text which should appear before citation.
1232 \begin_layout Description
1233 Origin AAS, 97-02-23
1236 \begin_layout Subsection*
1239 \begin_layout Description
1240 Action Pastes text from the active clipboard (retains formatting if the clipboard contains formatted text). Pastes plain text if plain text is on the clipboard, but tries to interpret it in special ways for certain insets, e.g. converting csv data to rows and columns if the paste happens in a tabular inset.
1242 \begin_layout Description
1243 Notion Historically, LFUN_CLIPBOARD_PASTE was introduced as a counterpart of LFUN_PRIMARY_SELECTION_PASTE: It behaved exactly the same, but the source is the clipboard, not the selection.
1245 \begin_layout Description
1246 Syntax clipboard-paste [<ARG>]
1248 \begin_layout Description
1249 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1251 \begin_layout Description
1252 Origin Georg, 10 Jul 2006
1255 \begin_layout Subsection*
1256 clipboard-paste-simple
1258 \begin_layout Description
1259 Action Pastes plain text from the active clipboard even if formatted LyX content is in the clipboard. Pastes plain text if plain text is on the clipboard, without trying to interpret it in special ways for certain insets, e.g. converting csv data to rows and columns if the paste happens in a tabular inset.
1261 \begin_layout Description
1262 Syntax clipboard-paste-simple [<ARG>]
1264 \begin_layout Description
1265 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1268 \begin_layout Subsection*
1271 \begin_layout Description
1272 Action Switches the focus to the minibuffer so that the user can type in there. If necessary, it opens the minibuffer toolbar.
1274 \begin_layout Description
1275 Notion Usually bound to M-x shortcut.
1277 \begin_layout Description
1278 Syntax command-execute
1281 \begin_layout Subsection*
1284 \begin_layout Description
1285 Action Try to complete the word or command at the cursor position.
1287 \begin_layout Description
1290 \begin_layout Description
1291 Origin sts, Feb 19 2008
1294 \begin_layout Subsection*
1297 \begin_layout Description
1298 Action Accept suggested completion.
1300 \begin_layout Description
1301 Syntax completion-accept
1303 \begin_layout Description
1304 Origin sanda, Sep 08 2008
1307 \begin_layout Subsection*
1310 \begin_layout Description
1311 Action Try to cancel completion, either the popup or the inline completion.
1313 \begin_layout Description
1314 Syntax completion-cancel
1316 \begin_layout Description
1317 Origin sts, Sep 07 2008
1320 \begin_layout Subsection*
1323 \begin_layout Description
1324 Action Show the inline completion at the cursor position.
1326 \begin_layout Description
1327 Syntax completion-inline
1329 \begin_layout Description
1330 Origin sts, Feb 19 2008
1333 \begin_layout Subsection*
1336 \begin_layout Description
1337 Action Show the completion popup at the cursor position.
1339 \begin_layout Description
1340 Syntax completion-popup
1342 \begin_layout Description
1343 Origin sts, Feb 19 2008
1346 \begin_layout Subsection*
1349 \begin_layout Description
1350 Action Copies the current selection to the clipboard.
1352 \begin_layout Description
1356 \begin_layout Subsection*
1359 \begin_layout Description
1360 Action Cuts to the clipboard.
1362 \begin_layout Description
1366 \begin_layout Subsection*
1369 \begin_layout Description
1370 Action Inserts the current date.
1372 \begin_layout Description
1373 Syntax date-insert [<ARG>]
1375 \begin_layout Description
1376 Params <ARG>: Format of date. The default value (%x) can be set in Preferences->Date format. For possible formats see manual page of strftime function.
1378 \begin_layout Description
1379 Origin jdblair, 31 Jan 2000
1382 \begin_layout Subsection*
1385 \begin_layout Description
1386 Action Decrease the nesting depth of the (selected) paragraph(s) inside lists.
1388 \begin_layout Description
1389 Syntax depth-decrement
1392 \begin_layout Subsection*
1395 \begin_layout Description
1396 Action Increase the nesting depth of the (selected) paragraph(s) inside lists.
1398 \begin_layout Description
1399 Syntax depth-increment
1402 \begin_layout Subsection*
1403 dialog-disconnect-inset
1405 \begin_layout Description
1406 Action Closes opened connection to opened inset.
1408 \begin_layout Description
1409 Notion Connection is used for apply functions.
1411 \begin_layout Description
1412 Syntax dialog-disconnect-inset <INSET-NAME>
1414 \begin_layout Description
1415 Origin leeming, 25 Feb 2003
1418 \begin_layout Subsection*
1421 \begin_layout Description
1422 Action Hides showed dialog. Counterpart to LFUN_DIALOG_SHOW .
1424 \begin_layout Description
1425 Syntax dialog-hide <NAME>
1427 \begin_layout Description
1428 Params See LFUN_DIALOG_SHOW .
1430 \begin_layout Description
1431 Origin leeming, 25 Feb 2003
1434 \begin_layout Subsection*
1437 \begin_layout Description
1438 Action Shows hidden dialog or creates new one for a given function/inset settings etc.
1440 \begin_layout Description
1441 Syntax dialog-show <NAME> [<DATA>]
1443 \begin_layout Description
1444 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
1445 \begin_inset Newline newline
1448 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|
1449 \begin_inset Newline newline
1452 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|
1453 \begin_inset Newline newline
1456 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|
1457 \begin_inset Newline newline
1460 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|
1461 \begin_inset Newline newline
1464 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL>
1465 \begin_inset Newline newline
1468 <SPECIAL>: latexlog|vclog
1469 \begin_inset Newline newline
1472 <DATA>: data, usually settings for the given dialog. Use debug mode for the details.
1474 \begin_layout Description
1475 Origin leeming, 17 Jun 2003
1478 \begin_layout Subsection*
1479 dialog-show-new-inset
1481 \begin_layout Description
1482 Action Shows hidden dialog or create new one for a given inset settings etc.
1484 \begin_layout Description
1485 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given inset.
1487 \begin_layout Description
1488 Syntax dialog-show-new-inset <NAME> [<DATA>]
1490 \begin_layout Description
1491 Params See LFUN_DIALOG_SHOW .
1493 \begin_layout Description
1494 Origin leeming, 25 Feb 2003
1497 \begin_layout Subsection*
1500 \begin_layout Description
1501 Action Toggles dialog between showed/hidden state.
1503 \begin_layout Description
1504 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
1506 \begin_layout Description
1507 Syntax dialog-toggle <NAME> [<DATA>]
1509 \begin_layout Description
1510 Params See LFUN_DIALOG_SHOW .
1512 \begin_layout Description
1513 Origin JSpitzm, 30 Apr 2007
1516 \begin_layout Subsection*
1519 \begin_layout Description
1520 Action Updates the dialog values from the inset/paragraph/document.
1522 \begin_layout Description
1523 Syntax dialog-update <NAME>
1525 \begin_layout Description
1526 Params <NAME>: paragraph|prefs|<INSET>
1527 \begin_inset Newline newline
1532 \begin_layout Description
1533 Origin leeming, 25 Feb 2003
1536 \begin_layout Subsection*
1539 \begin_layout Description
1540 Action Moves the cursor one line in downward direction.
1542 \begin_layout Description
1546 \begin_layout Subsection*
1549 \begin_layout Description
1550 Action Moves the cursor one line in downward direction adding the current position to the selection.
1552 \begin_layout Description
1556 \begin_layout Subsection*
1559 \begin_layout Description
1560 Action Inserts an ERT inset.
1562 \begin_layout Description
1565 \begin_layout Description
1566 Origin Jug, 18 Feb 2000
1569 \begin_layout Subsection*
1572 \begin_layout Description
1573 Action Clears the selection. If no text is selected call LFUN_FINISHED_FORWARD. Inside math mode jumps out of the math inset.
1575 \begin_layout Description
1578 \begin_layout Description
1579 Origin Lgb, 17 May 2001
1582 \begin_layout Subsection*
1585 \begin_layout Description
1586 Action Inserts another LyX file.
1588 \begin_layout Description
1589 Syntax file-insert [<FILE>]
1591 \begin_layout Description
1592 Params <FILE>: Filename to be inserted.
1595 \begin_layout Subsection*
1596 file-insert-plaintext
1598 \begin_layout Description
1599 Action Inserts plain text file.
1601 \begin_layout Description
1602 Syntax file-insert-plaintext [<FILE>]
1604 \begin_layout Description
1605 Params <FILE>: Filename to be inserted.
1607 \begin_layout Description
1608 Origin CFO-G, 19 Nov 1997
1611 \begin_layout Subsection*
1612 file-insert-plaintext-para
1614 \begin_layout Description
1615 Action Inserts plain text file as paragraph (i.e. join lines).
1617 \begin_layout Description
1618 Syntax file-insert-plaintext-para [<FILE>]
1620 \begin_layout Description
1621 Params <FILE>: Filename to be inserted.
1623 \begin_layout Description
1624 Origin Levon, 14 Feb 2001
1627 \begin_layout Subsection*
1630 \begin_layout Description
1631 Action Inserts CharStyle, Custom inset or XML short element.
1633 \begin_layout Description
1634 Notion Look into the Customization manual for more information about these elements.
1635 \begin_inset Newline newline
1638 To make this command enabled the layout file for the document class you're using has to load the character styles. There are a few contained in the Logical Markup module. You can also of course create some yourself.
1639 \begin_inset Newline newline
1642 For dissolving the element see LFUN_INSET_DISSOLVE.
1644 \begin_layout Description
1645 Syntax flex-insert Name
1647 \begin_layout Description
1648 Params Name: This name must be defined either in your layout file or imported by some module. The definition is InsetLayout Name or InsetLayout <Flex:Name>. The Flex: prefix is optional.
1650 \begin_layout Description
1651 Sample flex-insert Code
1654 \begin_layout Subsection*
1657 \begin_layout Description
1658 Action Inserts a float inset.
1660 \begin_layout Description
1661 Syntax float-insert <TYPE>
1663 \begin_layout Description
1664 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
1666 \begin_layout Description
1667 Origin Lgb, 27 Jun 2000
1670 \begin_layout Subsection*
1673 \begin_layout Description
1674 Action Inserts the list of floats in the document.
1676 \begin_layout Description
1677 Syntax float-list-insert <TYPE>
1679 \begin_layout Description
1680 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
1682 \begin_layout Description
1683 Origin Lgb, 3 May 2001
1686 \begin_layout Subsection*
1689 \begin_layout Description
1690 Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
1692 \begin_layout Description
1693 Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
1695 \begin_layout Description
1696 Syntax float-wide-insert <TYPE>
1698 \begin_layout Description
1699 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
1701 \begin_layout Description
1702 Origin Lgb, 31 Oct 2001
1705 \begin_layout Subsection*
1708 \begin_layout Description
1709 Action Inserts a footnote inset.
1711 \begin_layout Description
1712 Syntax footnote-insert
1714 \begin_layout Description
1715 Origin Jug, 7 Mar 2000
1718 \begin_layout Subsection*
1721 \begin_layout Description
1722 Action Reloads the image if necessary.
1724 \begin_layout Description
1725 Syntax graphics-reload
1727 \begin_layout Description
1728 Origin vfr, 10 Aug 2009
1731 \begin_layout Subsection*
1734 \begin_layout Description
1735 Action Inserts hyperlinks into the document (clickable in pdf output).
1737 \begin_layout Description
1738 Notion Hyperlink target can be set via selection + hyperlink-insert function.
1740 \begin_layout Description
1741 Syntax href-insert [<TARGET>]
1743 \begin_layout Description
1744 Origin CFO-G, 21 Nov 1997
1747 \begin_layout Subsection*
1750 \begin_layout Description
1751 Action Only active in IPA inset.
1753 \begin_layout Description
1754 Notion Dummy function which is only active in a IPA inset. It's used to toggle the IPA toolbar if the cursor moves into an IPA inset.
1756 \begin_layout Description
1759 \begin_layout Description
1760 Origin spitz, 20 May 2012
1763 \begin_layout Subsection*
1766 \begin_layout Description
1767 Action Inserts Index entry.
1769 \begin_layout Description
1770 Notion It automatically takes the word on the cursor position.
1772 \begin_layout Description
1773 Syntax index-insert [<TYPE:Name>]
1775 \begin_layout Description
1776 Params <TYPE:Name>: name of the index, if multiple indices are defined. With an empty argument, the default index is selected.
1778 \begin_layout Description
1779 Origin leeming, 3 Aug 2000
1782 \begin_layout Subsection*
1785 \begin_layout Description
1786 Action Inserts list of Index entries on a new page.
1788 \begin_layout Description
1789 Syntax index-print [<TYPE:Name>]
1791 \begin_layout Description
1792 Params <TYPE:Name>: name of the index, if multiple indices are defined. With an empty argument, the default index is selected.
1794 \begin_layout Description
1795 Origin Lgb, 27 Feb 1997
1798 \begin_layout Subsection*
1801 \begin_layout Description
1802 Action Displays shortcuts, lyxrc, package and textclass availability and menu information in a non-editable boxed InsetText.
1804 \begin_layout Description
1805 Notion Apart from lfun arguments you can use the following method:
1806 \begin_inset Newline newline
1809 1. input the type and argument of this inset, e.g. "menu paste", in the work area.
1810 \begin_inset Newline newline
1813 2. select the text and run info-insert lfun.
1815 \begin_layout Description
1816 Syntax info-insert <TYPE> <ARG>
1818 \begin_layout Description
1819 Params <TYPE>: shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|buffer
1820 \begin_inset Newline newline
1823 <ARG>: argument for a given type. Look into InsetInfo.h for detailed description.
1824 \begin_inset Newline newline
1827 shortcut[s]: name of lfun (e.g math-insert
1830 \begin_inset Newline newline
1833 lyxrc: name of rc_entry (e.g. bind_file)
1834 \begin_inset Newline newline
1837 lyxinfo: "version" - used version of LyX
1838 \begin_inset Newline newline
1841 package: name of latex package (e.g. listings)
1842 \begin_inset Newline newline
1845 textclass: name of textclass (e.g. article)
1846 \begin_inset Newline newline
1849 menu: name of lfun used in menu
1850 \begin_inset Newline newline
1853 icon: icon of lfun used in toolbar or direct icon name
1854 \begin_inset Newline newline
1857 buffer: "name"|"path"|"class"|"vcs-tree-revision"| "vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time"
1859 \begin_layout Description
1860 Sample command-sequence info-insert buffer path; info-insert buffer name
1862 \begin_layout Description
1863 Origin bpeng, 7 Oct 2007
1866 \begin_layout Subsection*
1869 \begin_layout Description
1870 Action Apply data for an inset.
1872 \begin_layout Description
1873 Notion LFUN_INSET_APPLY is sent from the dialogs when the data should be applied. This is either changed to LFUN_INSET_MODIFY or LFUN_INSET_INSERT depending on the context where it is called.
1875 \begin_layout Description
1876 Syntax inset-apply <ARGS>
1878 \begin_layout Description
1879 Params See LFUN_INSET_INSERT .
1882 \begin_layout Subsection*
1885 \begin_layout Description
1886 Action Move the cursor to the beginning of the current inset if it is not already there, or at the beginning of the enclosing inset otherwise
1888 \begin_layout Description
1891 \begin_layout Description
1892 Origin lasgouttes, 16 Mar 2009
1895 \begin_layout Subsection*
1898 \begin_layout Description
1899 Action Move the cursor to the beginning of the current inset if it is not already there, or at the beginning of the enclosing inset otherwise (adding the traversed text to the selection).
1901 \begin_layout Description
1902 Syntax inset-begin-select
1904 \begin_layout Description
1905 Origin lasgouttes, 16 Mar 2009
1908 \begin_layout Subsection*
1911 \begin_layout Description
1912 Action Copies the inset to the clipboard as a certain type.
1914 \begin_layout Description
1915 Notion Currently used only for InsetInfo where its content is copied as a text.
1917 \begin_layout Description
1918 Syntax inset-copy-as
1920 \begin_layout Description
1921 Origin vfr, 18 Apr 2010
1924 \begin_layout Subsection*
1927 \begin_layout Description
1928 Action Dissolve the current inset into text.
1930 \begin_layout Description
1931 Syntax inset-dissolve [<INSET>]
1933 \begin_layout Description
1934 Params <INSET>: this can be used to make sure the right kind of inset is dissolved. For example "dissolve" entry in the charstyles sub-menu should only dissolve the charstyle inset, even if the cursor is inside several nested insets of different type.
1935 \begin_inset Newline newline
1938 For values see lyx::InsetLayout::lyxtype_ .
1940 \begin_layout Description
1941 Origin JSpitz, 7 Aug 2006
1944 \begin_layout Subsection*
1947 \begin_layout Description
1948 Action Edit the inset at cursor with an external application, if one is attributed.
1950 \begin_layout Description
1951 Syntax inset-edit [<INSET_PARAMS>]
1953 \begin_layout Description
1954 Params <INSET_PARAMS>: Parameters for the inset.
1955 \begin_inset Newline newline
1958 Currently only the filename will be considered.
1960 \begin_layout Description
1961 Origin JSpitzm, 27 Apr 2006
1964 \begin_layout Subsection*
1967 \begin_layout Description
1968 Action Move the cursor to the end of the current inset if it is not already there, or at the end of the enclosing inset otherwise
1970 \begin_layout Description
1973 \begin_layout Description
1974 Origin lasgouttes, 16 Mar 2009
1977 \begin_layout Subsection*
1980 \begin_layout Description
1981 Action Move the cursor to the end of the current inset if it is not already there, or at the end of the enclosing inset otherwise (adding the traversed text to the selection).
1983 \begin_layout Description
1984 Syntax inset-end-select
1986 \begin_layout Description
1987 Origin lasgouttes, 16 Mar 2009
1990 \begin_layout Subsection*
1993 \begin_layout Description
1994 Action Apply the given commands on insets of a given name.
1996 \begin_layout Description
1997 Notion WARNING: use at your own risks; this function gives you too many ways of shooting yourself in the foot. A typical example is inset-forall Note note-insert which starts an infinite loop. This is mitigated by the fact that the number of actions is arbitrarily limited to 100000. Note also that inset-forall does not update metrics between iterations, which can lead to bugs. This has to be eventually fixed.
1999 \begin_layout Description
2000 Syntax inset-forall <NAME> <LFUN-COMMAND>
2001 \begin_inset Newline newline
2004 <NAME>: Type of Inset. If <NAME> is *, all insets are matched. The name is used like for InsetLayout in layout files: "Note" matches all note insets, while "Note:Note" only matches LyX yellow note insets.
2006 \begin_layout Description
2007 Sample Remove all index insets:
2008 \begin_inset Newline newline
2011 inset-forall Index char-delete-forward
2012 \begin_inset Newline newline
2015 Close all Notes (also works for a particular branch, for example):
2016 \begin_inset Newline newline
2019 inset-forall Note inset-toggle close
2020 \begin_inset Newline newline
2023 Transform all yellow notes to comments
2024 \begin_inset Newline newline
2027 inset-forall Note:Note inset-modify note Note Comment
2028 \begin_inset Newline newline
2031 Try to put LyX in an infinite loop if there is at least a Note:
2032 \begin_inset Newline newline
2035 inset-forall Note char-backward
2037 \begin_layout Description
2038 Origin lasgouttes, 27 Nov 2009
2041 \begin_layout Subsection*
2044 \begin_layout Description
2045 Action Insert new inset (type given by the parameters).
2047 \begin_layout Description
2048 Syntax inset-insert <INSET> <ARGS>
2050 \begin_layout Description
2051 Params <INSET>: <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|
2052 \begin_inset Newline newline
2055 hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>
2056 \begin_inset Newline newline
2059 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2061 \begin_layout Description
2062 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
2065 \begin_inset Newline newline
2068 where <label name> is the name of the referenced label and <Format> is one of the following:
2069 \begin_inset Newline newline
2073 \begin_inset Newline newline
2076 eqref -- (<reference>)
2077 \begin_inset Newline newline
2081 \begin_inset Newline newline
2084 vpageref -- on <page>
2085 \begin_inset Newline newline
2088 vref -- <reference> on <page>
2089 \begin_inset Newline newline
2092 formatted -- Formatted reference
2095 \begin_layout Subsection*
2098 \begin_layout Description
2099 Action Modify some properties of an inset.
2101 \begin_layout Description
2102 Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats, graphics, include, index, info, label, listings, newline, newpage, nomencl, note, phantom, ref, space, tabular, vspace, wrap insets.
2104 \begin_layout Description
2105 Syntax inset-modify <INSET> <ARGS>inset-modify changetype <TYPE>inset-modify tabular <FEATURE> [<ARG>]
2107 \begin_layout Description
2108 Params Generally see LFUN_INSET_INSERT for further details.
2109 \begin_inset Newline newline
2112 In case that <INSET> is "tabular" various math-environment features are handled as well, e.g. add-vline-left/right for the Grid/Array environment.
2113 \begin_inset Newline newline
2116 <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|
2117 \begin_inset Newline newline
2120 copy-column|move-column-right|move-column-left|move-row-down|move-row-up|
2121 \begin_inset Newline newline
2124 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
2125 \begin_inset Newline newline
2128 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|
2129 \begin_inset Newline newline
2132 valign-top|valign-bottom|valign-middle|longtabular-align-left|
2133 \begin_inset Newline newline
2136 longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|
2137 \begin_inset Newline newline
2140 m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|
2141 \begin_inset Newline newline
2144 set-all-lines|unset-all-lines|set-longtabular|unset-longtabular|set-pwidth|
2145 \begin_inset Newline newline
2148 set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
2149 \begin_inset Newline newline
2152 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
2153 \begin_inset Newline newline
2156 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
2157 \begin_inset Newline newline
2160 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
2161 \begin_inset Newline newline
2164 set-special-column|set-special-multicolumn|set-special-multirow|
2165 \begin_inset Newline newline
2168 set-booktabs|unset-booktabs|set-top-space|set-bottom-space|
2169 \begin_inset Newline newline
2172 set-interline-space|set-border-lines|tabular-valign-top|
2173 \begin_inset Newline newline
2176 tabular-valign-middle|tabular-valign-bottom|set-tabular-width <ARG>: additional argument for some commands, use debug mode to explore its values.
2178 \begin_layout Description
2179 Sample inset-modify note Note Comment
2180 \begin_inset Newline newline
2183 inset-modify changetype Ovalbox
2186 \begin_layout Subsection*
2189 \begin_layout Description
2190 Action Select all contents of an inset.
2192 \begin_layout Description
2193 Notion There are 3 successive levels: select current cell, select all cells of inset, select the inset from outside (in the enclosing inset).
2195 \begin_layout Description
2196 Syntax inset-select-all
2198 \begin_layout Description
2199 Origin vfr, 22 Aug 2009; lasgouttes 1 Nov 2014
2202 \begin_layout Subsection*
2205 \begin_layout Description
2206 Action Open the inset's properties dialog.
2208 \begin_layout Description
2209 Notion Used for bibitem, bibtex, box, branch, citation, ert, external, float, graphics, href, include, index, index_print, label, line, listings, note, phantom, ref, space, tabular, vspace, wrap insets.
2211 \begin_layout Description
2212 Syntax inset-settings <INSET>
2214 \begin_layout Description
2215 Params <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
2216 \begin_inset Newline newline
2219 graphics|href|include|index|index_print|label|line|
2220 \begin_inset Newline newline
2223 listings|note|phantom|ref|space|tabular|vspace|wrap>.
2226 \begin_layout Subsection*
2229 \begin_layout Description
2230 Action Toggles the collapsible inset at cursor position, or the inset we are currently in.
2232 \begin_layout Description
2233 Syntax inset-toggle [<ARG>]
2235 \begin_layout Description
2236 Params <ARG>: <open|close|toggle|assign>.
2237 \begin_inset Newline newline
2240 open/close/toggle are for collapsible insets. toggle is used when no argument is given.
2241 \begin_inset Newline newline
2244 assign synchronize the branch-inset with activation status of the branch. Used for global toggling when changed activation.
2246 \begin_layout Description
2247 Origin lasgouttes, 19 Jul 2001
2250 \begin_layout Subsection*
2253 \begin_layout Description
2254 Action Inserts an IPA inset.
2256 \begin_layout Description
2259 \begin_layout Description
2260 Origin spitz, 05 Mar 2012
2263 \begin_layout Subsection*
2266 \begin_layout Description
2267 Action Inserts special IPA macros into the document.
2269 \begin_layout Description
2270 Syntax ipamacro-insert <CHAR>
2272 \begin_layout Description
2273 Params <CHAR>: tone-falling, tone-rising, tone-high-rising, tone-low-rising, tone-high-rising-falling, deco bottomtiebar, deco toptiebar.
2275 \begin_layout Description
2276 Origin JSpitzm, 22 Aug 2012
2279 \begin_layout Subsection*
2282 \begin_layout Description
2283 Action Turn off the loaded keyboard map.
2285 \begin_layout Description
2289 \begin_layout Subsection*
2292 \begin_layout Description
2293 Action Turn on the primary keyboard map.
2295 \begin_layout Description
2296 Notion Maps were widely used in past, when X-windows didn't have nowadays keyboard support. They can be still used to maintain uniform keyboard layout across the various platforms.
2297 \begin_inset Newline newline
2300 The language is to be set in the Preferences dialog.
2302 \begin_layout Description
2303 Syntax keymap-primary
2306 \begin_layout Subsection*
2309 \begin_layout Description
2310 Action Turn on the secondary keyboard map.
2312 \begin_layout Description
2313 Syntax keymap-secondary
2316 \begin_layout Subsection*
2319 \begin_layout Description
2320 Action Toggles keyboard maps (first/second/off).
2322 \begin_layout Description
2323 Syntax keymap-toggle
2325 \begin_layout Description
2326 Origin leeming, 30 Mar 2004
2329 \begin_layout Subsection*
2330 label-copy-as-reference
2332 \begin_layout Description
2333 Action Copies the label at the cursor as a cross-reference to be pasted elsewhere.
2335 \begin_layout Description
2336 Syntax copy-label-as-reference <LABEL>
2338 \begin_layout Description
2339 Params <LABEL>: The label to copy (for multi-line math)
2341 \begin_layout Description
2342 Origin sts, 16 Nov 2008
2345 \begin_layout Subsection*
2348 \begin_layout Description
2349 Action Goto a label.
2351 \begin_layout Description
2352 Syntax label-goto [<LABEL>]
2354 \begin_layout Description
2355 Params <LABEL>: Requested label. If no label is given and reference is on cursor position, Bookmark 0 is saved and cursor moves to the position of referenced label.
2357 \begin_layout Description
2358 Origin Ale, 6 Aug 1997
2361 \begin_layout Subsection*
2364 \begin_layout Description
2365 Action Inserts label to text or displayed formula.
2367 \begin_layout Description
2368 Syntax label-insert [<LABEL>]
2370 \begin_layout Description
2371 Params <LABEL>: Requested label. If no label is given dialog requesting name will be opened.
2374 \begin_layout Subsection*
2375 label-insert-as-reference
2377 \begin_layout Description
2378 Action Inserts the label (in ToC pane) as a cross-reference at the position of the cursor.
2380 \begin_layout Description
2381 Syntax label-insert-as-reference
2383 \begin_layout Description
2384 Origin vfr, 7 Apr 2009
2387 \begin_layout Subsection*
2390 \begin_layout Description
2391 Action Set language from the current cursor position.
2393 \begin_layout Description
2394 Syntax language <LANG> [set]
2396 \begin_layout Description
2397 Params <LANG>: Requested language. Look in lib/languages for the list. "language reset" or "language" (without param) reset to the document language. set: If used, the language will be set to the specified language. Otherwise, the language will be toggled (i.e., if the current language is LANG, switch to the document language or the default language, if LANG is the document language).
2399 \begin_layout Description
2400 Origin Dekel, 2 Mar 2000
2403 \begin_layout Subsection*
2406 \begin_layout Description
2407 Action Move the cursor to the beginning of the (screen) line.
2409 \begin_layout Description
2413 \begin_layout Subsection*
2416 \begin_layout Description
2417 Action Move the cursor to the beginning of the (screen) line adding the traversed text to the selection.
2419 \begin_layout Description
2420 Syntax line-begin-select
2423 \begin_layout Subsection*
2426 \begin_layout Description
2427 Action Deletes the letters to the end of the (screen) line or deletes the selection.
2429 \begin_layout Description
2430 Syntax line-delete-forward
2433 \begin_layout Subsection*
2436 \begin_layout Description
2437 Action Move the cursor to the end of the (screen) line.
2439 \begin_layout Description
2443 \begin_layout Subsection*
2446 \begin_layout Description
2447 Action Move the cursor to the end of the (screen) line adding the traversed text to the selection.
2449 \begin_layout Description
2450 Syntax line-end-select
2453 \begin_layout Subsection*
2456 \begin_layout Description
2457 Action Inserts a new listings inset.
2459 \begin_layout Description
2460 Syntax listing-insert
2462 \begin_layout Description
2463 Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
2466 \begin_layout Subsection*
2469 \begin_layout Description
2470 Action Inserts a marginal note.
2472 \begin_layout Description
2473 Syntax marginalnote-insert
2475 \begin_layout Description
2476 Origin Lgb, 26 Jun 2000
2479 \begin_layout Subsection*
2482 \begin_layout Description
2483 Action Disable selecting of text-region.
2485 \begin_layout Description
2489 \begin_layout Subsection*
2492 \begin_layout Description
2493 Action Enable selecting of text-region.
2495 \begin_layout Description
2496 Notion After enabling you can simply move arrow keys to get selected region.
2498 \begin_layout Description
2502 \begin_layout Subsection*
2505 \begin_layout Description
2506 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
2508 \begin_layout Description
2511 \begin_layout Description
2512 Origin Andre, May 5 2006
2515 \begin_layout Subsection*
2518 \begin_layout Description
2519 Action Inserts a line break or new line.
2521 \begin_layout Description
2522 Syntax newline-insert [<ARG>]
2524 \begin_layout Description
2525 Params <ARG>: <newline|linebreak> default: newline
2527 \begin_layout Description
2528 Origin JSpitzm, 25 Mar 2008
2531 \begin_layout Subsection*
2534 \begin_layout Description
2535 Action Inserts a new page.
2537 \begin_layout Description
2538 Syntax newpage-insert <ARG>
2540 \begin_layout Description
2541 Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
2543 \begin_layout Description
2544 Origin uwestoehr, 24 Nov 2007
2547 \begin_layout Subsection*
2550 \begin_layout Description
2551 Action Inserts Nomenclature entry.
2553 \begin_layout Description
2554 Notion It automatically takes the word on the cursor position if no symbol is given.
2556 \begin_layout Description
2557 Syntax nomencl-insert [<SYMBOL>]
2559 \begin_layout Description
2560 Origin Ugras, 4 Nov 2006
2563 \begin_layout Subsection*
2566 \begin_layout Description
2567 Action Inserts list of Nomenclature entries.
2569 \begin_layout Description
2570 Syntax nomenclature-print
2572 \begin_layout Description
2573 Origin Ugras, 4 Nov 2006
2576 \begin_layout Subsection*
2579 \begin_layout Description
2580 Action Inserts Note on the current cursor position, move selection inside the inset.
2582 \begin_layout Description
2583 Syntax note-insert [<TYPE>]
2585 \begin_layout Description
2586 Params <TYPE>: <Note|Greyedout|Comment> default: Note
2589 \begin_layout Subsection*
2592 \begin_layout Description
2593 Action Moves the cursor to the beginning of next Note inset.
2595 \begin_layout Description
2599 \begin_layout Subsection*
2602 \begin_layout Description
2603 Action Move the current group in the downward direction in the structure of the document.
2605 \begin_layout Description
2606 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
2608 \begin_layout Description
2611 \begin_layout Description
2612 Origin Vermeer, 23 Mar 2006
2615 \begin_layout Subsection*
2618 \begin_layout Description
2619 Action Moves the current group in the downward direction in the hierarchy of the document structure.
2621 \begin_layout Description
2622 Notion Part -> Chapter -> Section -> etc.
2624 \begin_layout Description
2627 \begin_layout Description
2628 Origin Vermeer, 23 Mar 2006
2631 \begin_layout Subsection*
2634 \begin_layout Description
2635 Action Moves the current group in the upward direction in the hierarchy of the document structure.
2637 \begin_layout Description
2638 Notion Part <- Chapter <- Section <- etc.
2640 \begin_layout Description
2643 \begin_layout Description
2644 Origin Vermeer, 23 Mar 2006
2647 \begin_layout Subsection*
2650 \begin_layout Description
2651 Action Move the current group in the upward direction in the structure of the document.
2653 \begin_layout Description
2654 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
2656 \begin_layout Description
2659 \begin_layout Description
2660 Origin Vermeer, 23 Mar 2006
2663 \begin_layout Subsection*
2666 \begin_layout Description
2667 Action Breaks the current paragraph at the current location.
2669 \begin_layout Description
2670 Notion Removes the selection.
2672 \begin_layout Description
2673 Syntax paragraph-break [<LAYOUT>]
2675 \begin_layout Description
2676 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to default layout) when the cursor is at the end of the line.
2679 \begin_layout Subsection*
2682 \begin_layout Description
2683 Action Move the cursor to the next paragraph (or beginning of the current one) in downward direction.
2685 \begin_layout Description
2686 Syntax paragraph-down
2688 \begin_layout Description
2689 Origin Asger, 1 Oct 1996
2692 \begin_layout Subsection*
2693 paragraph-down-select
2695 \begin_layout Description
2696 Action Move the cursor and select the text to the next paragraph (or beginning of the current one) in downward direction.
2698 \begin_layout Description
2699 Syntax paragraph-down-select
2701 \begin_layout Description
2702 Origin Asger, 1 Oct 1996
2705 \begin_layout Subsection*
2708 \begin_layout Description
2709 Action Jump to a paragraph given by its id number and optionally the desired position within the paragraph.
2711 \begin_layout Description
2712 Notion Note that id number of paragraph is not the sequential number of paragraph seen on the screen. Moreover the id is unique for all opened buffers (documents).
2714 \begin_layout Description
2715 Syntax paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
2717 \begin_layout Description
2718 Params <PAR_ID_NUMBER>: paragraph id
2719 \begin_inset Newline newline
2722 <POSITION_IN_PAR>: desired position within the paragraph
2724 \begin_layout Description
2725 Origin Dekel, 26 Aug 2000
2728 \begin_layout Subsection*
2731 \begin_layout Description
2732 Action Moves the current paragraph downwards in the document.
2734 \begin_layout Description
2735 Syntax paragraph-move-down
2737 \begin_layout Description
2738 Origin Edwin, 8 Apr 2006
2741 \begin_layout Subsection*
2744 \begin_layout Description
2745 Action Moves the current paragraph upwards in the document.
2747 \begin_layout Description
2748 Notion Movement through the document will possibly break the paragraph-depth (e.g. itemize structure).
2750 \begin_layout Description
2751 Syntax paragraph-move-up
2753 \begin_layout Description
2754 Origin Edwin, 8 Apr 2006
2757 \begin_layout Subsection*
2760 \begin_layout Description
2761 Action Change paragraph settings.
2763 \begin_layout Description
2764 Notion Modifies the current paragraph, or currently selected paragraphs. This function only modifies, and does not override, existing settings. Note that the "leftindent" indent setting is deprecated.
2766 \begin_layout Description
2767 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
2769 \begin_layout Description
2779 \begin_inset Newline newline
2784 paragraph_spacing default|single|onehalf|double|other SIZE
2785 \begin_inset Newline newline
2790 align block|left|right|center|default
2791 \begin_inset Newline newline
2796 labelwidthstring WIDTH|
2800 \begin_layout Description
2801 Origin rgh, Aug 15 2007
2804 \begin_layout Subsection*
2805 paragraph-params-apply
2807 \begin_layout Description
2808 Action Change paragraph settings.
2810 \begin_layout Description
2811 Notion Overwrite all nonspecified settings to the default ones. Use paragraph-params lfun if you don't want to overwrite others settings.
2813 \begin_layout Description
2814 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
2816 \begin_layout Description
2817 Params For parameters see LFUN_PARAGRAPH_PARAMS
2819 \begin_layout Description
2820 Origin leeming, 30 Mar 2004
2823 \begin_layout Subsection*
2826 \begin_layout Description
2827 Action Move the cursor to the next paragraph (or beginning of the current one) in upward direction.
2829 \begin_layout Description
2832 \begin_layout Description
2833 Origin Asger, 1 Oct 1996
2836 \begin_layout Subsection*
2839 \begin_layout Description
2840 Action Move the cursor and select the text to the next paragraph (or beginning of the current one) in upward direction.
2842 \begin_layout Description
2843 Syntax paragraph-up-select
2845 \begin_layout Description
2846 Origin Asger, 1 Oct 1996
2849 \begin_layout Subsection*
2852 \begin_layout Description
2853 Action Pastes material (text or picture) from the active clipboard.
2855 \begin_layout Description
2856 Syntax paste [<TYPE>|<NUM>]
2858 \begin_layout Description
2859 Params <TYPE>: emf|pdf|png|jpeg|linkback|wmf|latex|html
2860 \begin_inset Newline newline
2863 <NUM>: number of the selection in the internal clipboard stack to be pasted.
2866 \begin_layout Subsection*
2869 \begin_layout Description
2870 Action Inserts phantom on the current cursor position, move selection inside the inset.
2872 \begin_layout Description
2873 Syntax phantom-insert [<TYPE>]
2875 \begin_layout Description
2876 Params <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
2878 \begin_layout Description
2879 Origin uwestoehr, 30 Jan 2009
2882 \begin_layout Subsection*
2885 \begin_layout Description
2886 Action Inserts a new preview inset.
2888 \begin_layout Description
2889 Syntax preview-insert
2891 \begin_layout Description
2892 Origin vfr, 28 Mar 2010
2895 \begin_layout Subsection*
2896 primary-selection-paste
2898 \begin_layout Description
2899 Action Pastes the currently selected text.
2901 \begin_layout Description
2902 Notion Primary selection mechanism is linux-only thing.
2904 \begin_layout Description
2905 Syntax primary-selection-paste [<ARG>]
2907 \begin_layout Description
2908 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
2911 \begin_layout Subsection*
2914 \begin_layout Description
2915 Action Inserts quotes according to the type and quote-language preference.
2917 \begin_layout Description
2918 Notion Currently English, Swedish, German, Polish, French, Danish quotes are distinguished.
2920 \begin_layout Description
2921 Syntax quote-insert [<TYPE>]
2923 \begin_layout Description
2924 Params <TYPE>: 'single' for single quotes, otherwise double quotes will be used.
2927 \begin_layout Subsection*
2930 \begin_layout Description
2931 Action Redoes the last thing undone.
2933 \begin_layout Description
2937 \begin_layout Subsection*
2940 \begin_layout Description
2941 Action Go to the next label or cross-reference.
2943 \begin_layout Description
2944 Syntax reference-next
2946 \begin_layout Description
2947 Origin Dekel, 14 Jan 2001
2950 \begin_layout Subsection*
2953 \begin_layout Description
2954 Action Repeat the given command.
2956 \begin_layout Description
2957 Syntax repeat <COUNT> <LFUN-COMMAND>
2959 \begin_layout Description
2960 Origin Andre, 27 Oct 2003
2963 \begin_layout Subsection*
2966 \begin_layout Description
2967 Action Moves the cursor one page in downward direction.
2969 \begin_layout Description
2973 \begin_layout Subsection*
2976 \begin_layout Description
2977 Action Moves the cursor one screen in downward direction adding the current position to the selection.
2979 \begin_layout Description
2980 Syntax screen-down-select
2983 \begin_layout Subsection*
2986 \begin_layout Description
2987 Action Recenters the screen on the current cursor position.
2989 \begin_layout Description
2990 Syntax screen-recenter
2993 \begin_layout Subsection*
2996 \begin_layout Description
2997 Action Repositions the screen such that the cursor is visible.
2999 \begin_layout Description
3000 Syntax screen-show-cursor
3002 \begin_layout Description
3003 Origin vfr, 25 Mar 2009
3006 \begin_layout Subsection*
3009 \begin_layout Description
3010 Action Moves the cursor one page in upward direction.
3012 \begin_layout Description
3016 \begin_layout Subsection*
3019 \begin_layout Description
3020 Action Moves the cursor one page in upward direction adding the current position to the selection.
3022 \begin_layout Description
3023 Syntax screen-up-select
3026 \begin_layout Subsection*
3029 \begin_layout Description
3030 Action Inserts a subscript or superscript inset.
3032 \begin_layout Description
3033 Syntax script-insert <TYPE>
3035 \begin_layout Description
3036 Params <TYPE>: subscript|superscript
3038 \begin_layout Description
3039 Origin Georg, 23 Nov 2010
3042 \begin_layout Subsection*
3045 \begin_layout Description
3046 Action Scroll the buffer view.
3048 \begin_layout Description
3049 Notion Only scrolls the screen up or down; does not move the cursor.
3051 \begin_layout Description
3052 Syntax scroll <TYPE> <QUANTITY>
3054 \begin_layout Description
3055 Params <TYPE>: line|page
3056 \begin_inset Newline newline
3059 <QUANTITY>: up|down|<number>
3061 \begin_layout Description
3062 Origin Abdel, Dec 27 2007
3065 \begin_layout Subsection*
3068 \begin_layout Description
3069 Action Select the whole section.
3071 \begin_layout Description
3072 Notion The cursor should be in a section heading before calling this lfun.
3074 \begin_layout Description
3075 Syntax section-select
3077 \begin_layout Description
3078 Origin vfr, 05 May 2009
3081 \begin_layout Subsection*
3084 \begin_layout Description
3085 Action Pastes the internal selection text in permanent selection.
3087 \begin_layout Description
3088 Notion Created in order to have middle mouse button pasting correct (bound to command-alternatives selection-paste ; primary-selection-paste paragraph).
3090 \begin_layout Description
3091 Syntax selection-paste
3093 \begin_layout Description
3094 Origin lasgouttes, 14 Jan 2009
3097 \begin_layout Subsection*
3100 \begin_layout Description
3101 Action Inserts an environment separator or paragraph break.
3103 \begin_layout Description
3104 Syntax separator-insert [<ARG>]
3106 \begin_layout Description
3107 Params <ARG>: <plain|parbreak> default: plain
3109 \begin_layout Description
3110 Origin ef, 2 May 2014
3113 \begin_layout Subsection*
3116 \begin_layout Description
3117 Action Set the group for the graphics inset on the cursor position.
3119 \begin_layout Description
3120 Syntax set-graphics-group [<GROUP>]
3122 \begin_layout Description
3123 Params <GROUP>: Id for an existing group. In case the Id is an empty string, the graphics inset is removed from the current group.
3125 \begin_layout Description
3126 Origin sanda, 6 May 2008
3129 \begin_layout Subsection*
3132 \begin_layout Description
3133 Action Inserts one of horizontal space insets.
3135 \begin_layout Description
3136 Syntax space-insert <NAME> [<LEN>]
3138 \begin_layout Description
3139 Params <NAME>: normal, protected, visible, thin, quad, qquad, enspace, enskip, negthinspace, negmedspace, negthickspace, hfill, hfill*, dotfill, hrulefill, hspace, hspace*
3140 \begin_inset Newline newline
3143 Only in math mode: med and thick.
3144 \begin_inset Newline newline
3147 <LEN>: length for custom spaces (hspace, hspace* for protected)
3149 \begin_layout Description
3150 Origin JSpitzm, 20 May 2003, Mar 17 2008
3153 \begin_layout Subsection*
3156 \begin_layout Description
3157 Action Inserts various characters into the document.
3159 \begin_layout Description
3160 Syntax specialchar-insert <CHAR>
3162 \begin_layout Description
3163 Params <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots, end-of-sentence, menu-separator, lyx, tex, latex, latex2e.
3165 \begin_layout Description
3166 Origin JSpitzm, 6 Dec 2007
3169 \begin_layout Subsection*
3172 \begin_layout Description
3173 Action Add the word under the cursor to the respective spell checker dictionary. The default for the language is retrieved from the cursor position.
3175 \begin_layout Description
3176 Syntax spelling-add [<STRING>] [<LANG>]
3178 \begin_layout Description
3179 Params <WORD>: word to add <LANG>: language name (see file languages)
3181 \begin_layout Description
3182 Origin JSpitzm, 18 Jan 2010
3185 \begin_layout Subsection*
3186 spelling-continuously
3188 \begin_layout Description
3189 Action Toggle continuous spell checking.
3191 \begin_layout Description
3192 Syntax spelling-continuously
3194 \begin_layout Description
3195 Origin vfr, 24 March 2013
3198 \begin_layout Subsection*
3201 \begin_layout Description
3202 Action Let the spell checker ignore the word under the cursor in the current session for the given language. The default for the language is retrieved from the cursor position.
3204 \begin_layout Description
3205 Syntax spelling-ignore [<WORD>] [<LANG>]
3207 \begin_layout Description
3208 Params <WORD>: word to ignore <LANG>: language name (see file languages)
3210 \begin_layout Description
3211 Origin JSpitzm, 18 Jan 2010
3214 \begin_layout Subsection*
3217 \begin_layout Description
3218 Action Remove the word under the cursor from the respective spell checker dictionary. The default for the language is retrieved from the cursor position.
3220 \begin_layout Description
3221 Syntax spelling-remove [<STRING>] [<LANG>]
3223 \begin_layout Description
3224 Params <WORD>: word to remove <LANG>: language name (see file languages)
3226 \begin_layout Description
3227 Origin SWitt, 28 July 2010
3230 \begin_layout Subsection*
3233 \begin_layout Description
3234 Action Delete a tab or up to an equivalent amount of spaces from a listings inset.
3236 \begin_layout Description
3237 Notion It also works on a selection - it removes a tab or spaces from the beginning of each line spanned by the selection. This is useful if you want to indent/unindent multiple lines in one action.
3239 \begin_layout Description
3242 \begin_layout Description
3243 Origin vfr, Sep 30 2008
3246 \begin_layout Subsection*
3249 \begin_layout Description
3250 Action Insert a tab into a listings inset.
3252 \begin_layout Description
3253 Notion It also works on a selection.
3255 \begin_layout Description
3258 \begin_layout Description
3259 Origin vfr, Sep 30 2008
3262 \begin_layout Subsection*
3265 \begin_layout Description
3266 Action Inserts table into the document.
3268 \begin_layout Description
3269 Notion See LFUN_INSET_MODIFY for some more details about tabular modifications.
3271 \begin_layout Description
3272 Syntax tabular-insert [<ROWS> <COLUMNS>]
3274 \begin_layout Description
3275 Params In case no arguments are given show insert dialog.
3277 \begin_layout Description
3278 Origin Jug, 12 Apr 2000
3281 \begin_layout Subsection*
3284 \begin_layout Description
3285 Action Look up thesaurus entries with respect to the word under the cursor.
3287 \begin_layout Description
3288 Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
3290 \begin_layout Description
3291 Params <STRING>: word to look up <LANG>: language (see file languages)
3293 \begin_layout Description
3294 Origin Levon, 20 Jul 2001
3297 \begin_layout Subsection*
3300 \begin_layout Description
3301 Action Undoes the last edit.
3303 \begin_layout Description
3307 \begin_layout Subsection*
3310 \begin_layout Description
3311 Action Inserts a single unicode character.
3313 \begin_layout Description
3314 Syntax unicode-insert <CHAR>
3316 \begin_layout Description
3317 Params <CHAR>: The character to insert, given as its code point, in hexadecimal.
3319 \begin_layout Description
3320 Sample unicode-insert 0x0100
3322 \begin_layout Description
3323 Origin Lgb, 22 Oct 2006
3326 \begin_layout Subsection*
3329 \begin_layout Description
3330 Action Moves the cursor one line in upward direction.
3332 \begin_layout Description
3336 \begin_layout Subsection*
3339 \begin_layout Description
3340 Action Moves the cursor one line in upward direction adding the current position to the selection.
3342 \begin_layout Description
3346 \begin_layout Subsection*
3349 \begin_layout Description
3350 Action Moves the cursor to the logically previous beginning of a word.
3352 \begin_layout Description
3353 Notion This is not the action which should be bound to the arrow keys, because backwards may be left or right, depending on the language. The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions, which in turn may employ this one.
3355 \begin_layout Description
3356 Syntax word-backward
3359 \begin_layout Subsection*
3360 word-backward-select
3362 \begin_layout Description
3363 Action Moves the cursor to the logically previous beginning of a word, adding the logically traversed text to the selection.
3365 \begin_layout Description
3366 Notion See also LFUN_WORD_BACKWARD.
3368 \begin_layout Description
3369 Syntax word-backward-select
3372 \begin_layout Subsection*
3375 \begin_layout Description
3376 Action Capitalizes the words in the selection (i.e. the first letters) or the first letter of word at cursor position.
3378 \begin_layout Description
3379 Syntax word-capitalize [<SEL_TYPE>]
3381 \begin_layout Description
3382 Params <SEL_TYPE>: if this is equal to "partial", then the default word starts at cursor position (emacs-style). Otherwise, the whole word is considered.
3385 \begin_layout Subsection*
3386 word-delete-backward
3388 \begin_layout Description
3389 Action Deletes characters to the beginning of the word (usually the "C+BackSpace" key).
3391 \begin_layout Description
3392 Syntax word-delete-backward
3395 \begin_layout Subsection*
3398 \begin_layout Description
3399 Action Deletes characters to the end of the word (usually the "C+Delete" key).
3401 \begin_layout Description
3402 Syntax word-delete-forward
3405 \begin_layout Subsection*
3408 \begin_layout Description
3409 Action Search for next occurrence of a string.
3411 \begin_layout Description
3412 Syntax word-find [<DATA>]
3414 \begin_layout Description
3415 Params <DATA>: data encoded from Find dialog (see lyx::find2string()). If no parameter is given, search with last find-dialog data is used for search (i.e. find-next).
3417 \begin_layout Description
3418 Origin Andre, Jan 7 2004
3421 \begin_layout Subsection*
3424 \begin_layout Description
3425 Action Search for a given string in backward direction.
3427 \begin_layout Description
3428 Notion Case sensitive, match words. If no argument given, last search repeated.
3430 \begin_layout Description
3431 Syntax word-find-backward [<STRING>]
3433 \begin_layout Description
3434 Origin Etienne, 20 Feb 1998
3437 \begin_layout Subsection*
3440 \begin_layout Description
3441 Action Search for a given string in forward direction.
3443 \begin_layout Description
3444 Notion Case sensitive, match words. If no argument given, last search repeated.
3446 \begin_layout Description
3447 Syntax word-find-forward [<STRING>]
3449 \begin_layout Description
3450 Origin Etienne, 16 Feb 1998
3453 \begin_layout Subsection*
3456 \begin_layout Description
3457 Action Search for next occurrence of a pattern.
3459 \begin_layout Description
3460 Syntax word-findadv [<DATA>]
3462 \begin_layout Description
3463 Params <DATA>: data encoded from FindAdv dialog (see lyx::findadv2string()). If no parameter is given, search with last find-dialog data is used for search (i.e. find-next).
3465 \begin_layout Description
3466 Origin Tommaso, Nov 15 2007
3469 \begin_layout Subsection*
3472 \begin_layout Description
3473 Action Moves the cursor to the logically next beginning of a word.
3475 \begin_layout Description
3476 Notion This is not the action which should be bound to the arrow keys, because forward may be left or right, depending on the language. The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions, which in turn may employ this one.
3478 \begin_layout Description
3482 \begin_layout Subsection*
3485 \begin_layout Description
3486 Action Moves the cursor to the logically next beginning of a word, adding the logically traversed text to the selection.
3488 \begin_layout Description
3489 Notion See also LFUN_WORD_FORWARD.
3491 \begin_layout Description
3492 Syntax word-forward-select
3495 \begin_layout Subsection*
3498 \begin_layout Description
3499 Action Moves the cursor to the next beginning of a word "on the left".
3501 \begin_layout Description
3502 Notion This is the action which should be taken when the (e.g., ctrl-) "left" key is pressed. Generally, it moves the cursor to the next beginning of a word on the left. However, in Bidi text this become slightly more complicated, and there are different modes of cursor movement. In "visual mode", this moves left, plain and simple. In "logical mode", movement is logically forward in RTL paragraphs, and logically backwards in LTR paragraphs.
3504 \begin_layout Description
3507 \begin_layout Description
3508 Origin dov, 28 Oct 2007
3511 \begin_layout Subsection*
3514 \begin_layout Description
3515 Action Moves the cursor to the next beginning of a word "on the left", adding *logically* traversed text to the selection.
3517 \begin_layout Description
3518 Notion See also LFUN_WORD_LEFT for exact details of the movement.
3520 \begin_layout Description
3521 Syntax word-left-select
3523 \begin_layout Description
3524 Origin dov, 28 Oct 2007
3527 \begin_layout Subsection*
3530 \begin_layout Description
3531 Action Change the words in the selection or word at cursor position to lower case.
3533 \begin_layout Description
3534 Syntax word-lowcase [<SEL_TYPE>]
3536 \begin_layout Description
3537 Params <SEL_TYPE>: if this is equal to "partial", then the default word starts at cursor position (emacs-style). Otherwise, the whole word is considered.
3540 \begin_layout Subsection*
3543 \begin_layout Description
3544 Action Replace a string in the document.
3546 \begin_layout Description
3547 Syntax word-replace [<DATA>]
3549 \begin_layout Description
3550 Params <DATA>: data is of the form "<replace>
3551 \begin_inset Newline newline
3555 \begin_inset Newline newline
3558 <casesensitive> <matchword> <all> <forward> <findnext>"
3560 \begin_layout Description
3561 Origin Andre, Jan 7 2004
3564 \begin_layout Subsection*
3567 \begin_layout Description
3568 Action Moves the cursor to the next beginning of a word "on the right".
3570 \begin_layout Description
3571 Notion This is the action which should be taken when the (e.g., ctrl-) "right" key is pressed. Generally, it moves the cursor to the next beginning of a word on the right. However, in Bidi text this become slightly more complicated, and there are different modes of cursor movement. In "visual mode", this moves right, plain and simple. In "logical mode", movement is logically forward in LTR paragraphs, and logically backwards in RTL paragraphs.
3573 \begin_layout Description
3576 \begin_layout Description
3577 Origin dov, 28 Oct 2007
3580 \begin_layout Subsection*
3583 \begin_layout Description
3584 Action Moves the cursor to the next beginning of a word "on the right", adding *logically* traversed text to the selection.
3586 \begin_layout Description
3587 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
3589 \begin_layout Description
3590 Syntax word-right-select
3592 \begin_layout Description
3593 Origin dov, 28 Oct 2007
3596 \begin_layout Subsection*
3599 \begin_layout Description
3600 Action Puts the word where the cursor stands into the selection.
3602 \begin_layout Description
3605 \begin_layout Description
3606 Origin Andre, 11 Sep 2002
3609 \begin_layout Subsection*
3612 \begin_layout Description
3613 Action Change the words in the selection or word at cursor position to upper case.
3615 \begin_layout Description
3616 Syntax word-upcase [<SEL_TYPE>]
3618 \begin_layout Description
3619 Params <SEL_TYPE>: if this is equal to "partial", then the default word starts at cursor position (emacs-style). Otherwise, the whole word is considered.
3622 \begin_layout Subsection*
3625 \begin_layout Description
3626 Action Inserts floats wrapped by the text around.
3628 \begin_layout Description
3629 Syntax wrap-insert <TYPE>
3631 \begin_layout Description
3632 Params <TYPE>: table|figure
3634 \begin_layout Description
3635 Origin Dekel, 7 Apr 2002
3638 \begin_layout Section
3639 Math Editor Functions
3641 \begin_layout Subsection*
3642 in-mathmacrotemplate
3644 \begin_layout Description
3645 Action Only active in Math Macro definition.
3647 \begin_layout Description
3648 Notion Dummy function which is only active in a Math Macro definition. It's used to toggle the Math Macro toolbar if the cursor moves into a Math Macro definition.
3650 \begin_layout Description
3651 Syntax in-mathmacrotemplate
3653 \begin_layout Description
3654 Origin sts, 06 January 2008
3657 \begin_layout Subsection*
3660 \begin_layout Description
3661 Action Inserts an extended matrix as provided by the amsmath package.
3663 \begin_layout Description
3664 Syntax math-matrix <COLS> <ROWS> [<DECORATION>]
3666 \begin_layout Description
3667 Params <DECORATION>: Decoration determines the LaTeX name of the matrix that should be created. Possible values include pmatrix, bmatrix, Bmatrix, vmatrix, Vmatrix and matrix. The default is 'matrix'.
3669 \begin_layout Description
3670 Sample math-ams-matrix 3 3 bmatrix
3673 \begin_layout Subsection*
3676 \begin_layout Description
3677 Action Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
3679 \begin_layout Description
3680 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
3682 \begin_layout Description
3683 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
3684 \begin_inset Newline newline
3687 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
3689 \begin_layout Description
3690 Sample math-bigdelim "Bigl" "
3696 \begin_layout Description
3697 Origin Enrico & Georg, 7 May 2006
3700 \begin_layout Subsection*
3703 \begin_layout Description
3704 Action Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
3706 \begin_layout Description
3707 Syntax math-delim [<LEFT>] [<RIGHT>]
3709 \begin_layout Description
3710 Params <LEFT/RIGHT>: Delimiters to be used. Each delimiter can be specified by either a LaTeX name or a valid character. ( is the default letter.
3712 \begin_layout Description
3713 Sample math-delim { rangle
3715 \begin_layout Description
3716 Origin Alejandro, 18 Jun 1996
3719 \begin_layout Subsection*
3722 \begin_layout Description
3723 Action Creates a new displayed equation in text mode. Toggles inlined/display formula in math mode.
3725 \begin_layout Description
3726 Syntax math-display [<ARG>]
3728 \begin_layout Description
3729 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating new equation from the text mode.
3731 \begin_layout Description
3732 Origin Alejandro, 18 Jun 1996
3735 \begin_layout Subsection*
3738 \begin_layout Description
3739 Action Calls external program and passes the current expression/equation as an argument for the calculation in the format appropriate to the given language.
3741 \begin_layout Description
3742 Notion Selection can be used to determine the input for the external program.
3744 \begin_layout Description
3745 Syntax math-extern <LANG> [<COMMAND>]
3747 \begin_layout Description
3748 Params <LANG>: octave|maxima|maple|mathematica|script
3749 \begin_inset Newline newline
3752 where "script" stands for the external script (normalized expression will be passed)
3754 \begin_layout Description
3755 Sample math-extern maple simplify
3757 \begin_layout Description
3758 Origin Andre, 24 Apr 2001
3761 \begin_layout Subsection*
3764 \begin_layout Description
3765 Action Changes the text style used in math.
3767 \begin_layout Description
3768 Syntax math-font-style <STYLE>
3770 \begin_layout Description
3771 Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal
3772 \begin_inset Newline newline
3775 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
3777 \begin_layout Description
3778 Origin vfr, 9 jan 2009
3781 \begin_layout Subsection*
3784 \begin_layout Description
3785 Action Inserts math objects and symbols.
3787 \begin_layout Description
3788 Notion When <ARG> is a _single_ math inset with more than one cell (such as "x_y^z" or "
3790 frac{x}{y}"), the content of cell(0) is replaced by the current selection (only works if the selection is in mathed). As an example, if "abc" is selected in mathed, "math-insert
3792 frac{x}{y}" replaces "abc" with "
3794 frac{abc}{y}", and "math-insert x_y^z" replaces "abc" with "abc_y^z". If nothing is selected (or the selection is not in mathed), math-insert works as expected.
3796 \begin_layout Description
3797 Syntax math-insert <ARG>
3799 \begin_layout Description
3800 Params <ARG>: Symbol or LaTeX code to be inserted.
3803 \begin_layout Subsection*
3806 \begin_layout Description
3807 Action Toggles the position of the limits from above/below to the right side an vice versa in integral symbol, a limit, a summation, etc.
3809 \begin_layout Description
3810 Notion Put the cursor before the symbol with the limits and then invoke math-limits.
3812 \begin_layout Description
3813 Syntax math-limits [<STATE>]
3815 \begin_layout Description
3816 Params <STATE>: limits|nolimits
3819 \begin_layout Subsection*
3822 \begin_layout Description
3823 Action Inserts a math macro definition at the cursor position in the text.
3825 \begin_layout Description
3826 Syntax math-macro <NAME> [<NARGS>] [def]
3828 \begin_layout Description
3829 Params <NAME>: The name of the macro, e.g. "mymacro".
3830 \begin_inset Newline newline
3833 <NARGS>: The number of parameters of the macro. Default is 0. "def": Has no effect anymore, just for compatibility with former LyX versions.
3835 \begin_layout Description
3836 Origin ale, 10 May 1997; sts, 21 Dec 2007
3839 \begin_layout Subsection*
3840 math-macro-add-greedy-optional-param
3842 \begin_layout Description
3843 Action Add a greedy optional parameter.
3845 \begin_layout Description
3846 Notion Add a greedy optional parameter which eats the value from the following cells in mathed which are in the [value] format.
3848 \begin_layout Description
3849 Syntax math-macro-add-greedy-optional-param
3851 \begin_layout Description
3852 Origin sts, 06 January 2008
3855 \begin_layout Subsection*
3856 math-macro-add-optional-param
3858 \begin_layout Description
3859 Action Add an optional parameter.
3861 \begin_layout Description
3862 Notion Insert an optional parameter just behind the already existing optional parameters.
3864 \begin_layout Description
3865 Syntax math-macro-add-optional-param
3867 \begin_layout Description
3868 Origin sts, 06 January 2008
3871 \begin_layout Subsection*
3872 math-macro-add-param
3874 \begin_layout Description
3875 Action Add a parameter.
3877 \begin_layout Description
3878 Notion Add a parameter to a Math Macro.
3880 \begin_layout Description
3881 Syntax math-macro-add-param <NUM>
3883 \begin_layout Description
3884 Params <NUM>: The number of the parameter behind which the new one will be added (1 for the first, i.e. use 0 for add a parameter at the left), defaults to the last one.
3886 \begin_layout Description
3887 Origin sts, 06 January 2008
3890 \begin_layout Subsection*
3891 math-macro-append-greedy-param
3893 \begin_layout Description
3894 Action Append a greedy parameter.
3896 \begin_layout Description
3897 Notion Append a greedy parameter to a Math Macro which eats the following mathed cell in every instance of the macro in the buffer.
3899 \begin_layout Description
3900 Syntax math-macro-append-greedy-param
3902 \begin_layout Description
3903 Origin sts, 06 January 2008
3906 \begin_layout Subsection*
3909 \begin_layout Description
3910 Action Fold a Math Macro.
3912 \begin_layout Description
3913 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e. displayed as
3917 \begin_layout Description
3918 Syntax math-macro-fold
3920 \begin_layout Description
3921 Origin sts, 06 January 2008
3924 \begin_layout Subsection*
3925 math-macro-make-nonoptional
3927 \begin_layout Description
3928 Action Make a parameter non-optional.
3930 \begin_layout Description
3931 Notion Turn the last optional parameter of a Math Macro into a non-optional parameter. The default value is remembered to be reused later if the user changes his mind.
3933 \begin_layout Description
3934 Syntax math-macro-make-nonoptional
3936 \begin_layout Description
3937 Origin sts, 06 January 2008
3940 \begin_layout Subsection*
3941 math-macro-make-optional
3943 \begin_layout Description
3944 Action Make a parameter optional.
3946 \begin_layout Description
3947 Notion Turn the first non-optional parameter of a Math Macro into an optional parameter with a default value.
3949 \begin_layout Description
3950 Syntax math-macro-make-optional
3952 \begin_layout Description
3953 Origin sts, 06 January 2008
3956 \begin_layout Subsection*
3957 math-macro-remove-greedy-param
3959 \begin_layout Description
3960 Action Remove a greedy parameter.
3962 \begin_layout Description
3963 Notion Remove a greedy parameter of a Math Macro and spit out the values of it in every instance of the macro in the buffer. If it is an optional parameter the [valud] format is used.
3965 \begin_layout Description
3966 Syntax math-macro-remove-greedy-param
3968 \begin_layout Description
3969 Origin sts, 06 January 2008
3972 \begin_layout Subsection*
3973 math-macro-remove-optional-param
3975 \begin_layout Description
3976 Action Remove the last optional parameter.
3978 \begin_layout Description
3979 Notion Remove the last optional parameter of a Math Macro and remove it in all the instances of the macro in the buffer.
3981 \begin_layout Description
3982 Syntax math-macro-remove-optional-param
3984 \begin_layout Description
3985 Origin sts, 06 January 2008
3988 \begin_layout Subsection*
3989 math-macro-remove-param
3991 \begin_layout Description
3992 Action Remove the last parameter.
3994 \begin_layout Description
3995 Notion Remove the last parameter of a Math Macro and remove its value in all instances of the macro in the buffer.
3997 \begin_layout Description
3998 Syntax math-macro-remove-param <NUM>
4000 \begin_layout Description
4001 Params <NUM>: The number of the parameter to be deleted (1 for the first), defaults to the last one.
4003 \begin_layout Description
4004 Origin sts, 06 January 2008
4007 \begin_layout Subsection*
4010 \begin_layout Description
4011 Action Unfold a Math Macro.
4013 \begin_layout Description
4014 Notion Unfold the Math Macro the cursor is in, i.e. display it as
4018 \begin_layout Description
4019 Syntax math-macro-unfold
4021 \begin_layout Description
4022 Origin sts, 06 January 2008
4025 \begin_layout Subsection*
4028 \begin_layout Description
4029 Action Inserts a matrix.
4031 \begin_layout Description
4032 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
4034 \begin_layout Description
4035 Params <ALIGN>: Alignment is a word composed of the vertical alignment (b, c or t) (i.e. 1 char) and the horizontal alignments (l, c or r) (i.e. <COL> chars).
4037 \begin_layout Description
4038 Sample math-matrix 3 3 bccc
4041 \begin_layout Subsection*
4044 \begin_layout Description
4045 Action In text mode enters math mode (i.e. puts math insets on the current cursor position), in math mode enters text mode inside math expression.
4047 \begin_layout Description
4048 Notion If there is some selected text, it puts the text inside created math box.
4050 \begin_layout Description
4051 Syntax math-mode [on|<ARG>]
4053 \begin_layout Description
4054 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT .
4055 \begin_inset Newline newline
4058 "on": allow only entering of math mode from text mode.
4060 \begin_layout Description
4061 Origin Alejandro, 4 Jun 1996
4064 \begin_layout Subsection*
4067 \begin_layout Description
4068 Action Mutates the type of math inset to the newly selected one.
4070 \begin_layout Description
4071 Syntax math-mutate <TYPE>
4073 \begin_layout Description
4074 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat| multline|gather|flalign
4076 \begin_layout Description
4077 Origin Andre, 23 May 2001
4080 \begin_layout Subsection*
4081 math-number-line-toggle
4083 \begin_layout Description
4084 Action Toggles numbering of the current formula line.
4086 \begin_layout Description
4087 Notion Must be in display formula mode.
4089 \begin_layout Description
4090 Syntax math-number-line-toggle
4092 \begin_layout Description
4093 Origin Alejandro, 18 Jun 1996
4096 \begin_layout Subsection*
4099 \begin_layout Description
4100 Action Toggles numbering/labeling of the current formula.
4102 \begin_layout Description
4103 Notion Must be in display formula mode.
4105 \begin_layout Description
4106 Syntax math-number-toggle
4108 \begin_layout Description
4109 Origin Alejandro, 4 Jun 1996
4112 \begin_layout Subsection*
4115 \begin_layout Description
4116 Action Changes arbitrarily the size used by math fonts inside a context.
4118 \begin_layout Description
4119 Notion Provides an interface to the LaTeX math mode font size commands.
4121 \begin_layout Description
4122 Syntax math-size <STYLE>
4124 \begin_layout Description
4135 \begin_layout Description
4136 Origin Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
4139 \begin_layout Subsection*
4142 \begin_layout Description
4143 Action Inserts space into math expression.
4145 \begin_layout Description
4146 Notion Use spacebar after entering this space to change type of space.
4148 \begin_layout Description
4149 Syntax math-space [<TYPE>] [<LEN>]
4151 \begin_layout Description
4152 Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
4153 \begin_inset Newline newline
4156 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
4157 \begin_inset Newline newline
4160 custom space: hspace
4161 \begin_inset Newline newline
4164 "," used by default.
4165 \begin_inset Newline newline
4168 Note that ! is equivalent to negthinspace, , = thinspace, : = medspace, and ; = thickspace.
4169 \begin_inset Newline newline
4172 <LEN>: length for custom spaces (hspace)
4174 \begin_layout Description
4175 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
4178 \begin_layout Subsection*
4181 \begin_layout Description
4182 Action Enters subscript expression in math expression.
4184 \begin_layout Description
4185 Syntax math-subscript
4187 \begin_layout Description
4188 Origin vermeer, 12 Dec 2001
4191 \begin_layout Subsection*
4194 \begin_layout Description
4195 Action Enters superscript expression in math expression.
4197 \begin_layout Description
4198 Syntax math-superscript
4200 \begin_layout Description
4201 Origin vermeer, 12 Dec 2001
4204 \begin_layout Subsection*
4207 \begin_layout Description
4208 Action Enters regexp mode (i.e., puts regexp insets on the current cursor position). Used by the advanced search dialog.
4210 \begin_layout Description
4211 Notion If there is any selected text, then it is moved inside the created regexp inset.
4213 \begin_layout Description
4214 Syntax regexp-mode [<ARG>]
4216 \begin_layout Description
4217 Params <ARG>: eventual argument (regular expression).
4219 \begin_layout Description
4220 Origin Tommaso, 4 Oct 2008
4223 \begin_layout Section
4224 Buffer Fuctions (File and Window related)
4226 \begin_layout Subsection*
4229 \begin_layout Description
4230 Action Activate the branch.
4232 \begin_layout Description
4233 Syntax branch-activate <BRANCH>
4235 \begin_layout Description
4236 Params <BRANCH>: The branch to activate
4238 \begin_layout Description
4239 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
4240 \begin_inset Newline newline
4243 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
4245 \begin_layout Description
4246 Origin rgh, 27 May 2008
4249 \begin_layout Subsection*
4252 \begin_layout Description
4253 Action Add a branch to the buffer's BranchList.
4255 \begin_layout Description
4256 Syntax branch-add <BRANCH>
4258 \begin_layout Description
4259 Params <BRANCH>: Name of the branch to add
4261 \begin_layout Description
4262 Origin spitz, 7 Jul 2009
4265 \begin_layout Subsection*
4268 \begin_layout Description
4269 Action Create new branch and directly put the branch inset into the document.
4271 \begin_layout Description
4272 Syntax branch-add-insert [<NAME>]
4274 \begin_layout Description
4275 Params <NAME>: Branch name. If it is not specified, you will be asked.
4277 \begin_layout Description
4278 Origin sanda, 10 Jul 2009
4281 \begin_layout Subsection*
4284 \begin_layout Description
4285 Action De-activate the branch.
4287 \begin_layout Description
4288 Syntax branch-deactivate <BRANCH>
4290 \begin_layout Description
4291 Params <BRANCH>: The branch to deactivate
4293 \begin_layout Description
4294 Origin rgh, 27 May 2008
4297 \begin_layout Subsection*
4298 branch-master-activate
4300 \begin_layout Description
4301 Action Activate the branch in the master buffer.
4303 \begin_layout Description
4304 Syntax branch-master-activate <BRANCH>
4306 \begin_layout Description
4307 Params <BRANCH>: The branch to activate
4309 \begin_layout Description
4310 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
4311 \begin_inset Newline newline
4314 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
4316 \begin_layout Description
4317 Origin spitz, 30 Sep 2012
4320 \begin_layout Subsection*
4321 branch-master-deactivate
4323 \begin_layout Description
4324 Action De-activate the branch in the master buffer.
4326 \begin_layout Description
4327 Syntax branch-master-deactivate <BRANCH>
4329 \begin_layout Description
4330 Params <BRANCH>: The branch to deactivate
4332 \begin_layout Description
4333 Origin spitz, 30 Sep 2012
4336 \begin_layout Subsection*
4339 \begin_layout Description
4340 Action Rename all branches of a given name in a document.
4342 \begin_layout Description
4343 Syntax branches-rename <OLDNAME> <NEWNAME>
4345 \begin_layout Description
4346 Params <OLDNAME>: Current name of the branch to be renamed <NEWNAME>: New name of the branch
4348 \begin_layout Description
4349 Origin spitz, 9 Jul 2009
4352 \begin_layout Subsection*
4355 \begin_layout Description
4356 Action Saves the current buffer to a temporary file.
4358 \begin_layout Description
4359 Notion Saves the current buffer to a file named "#filename#". This LFUN is called automatically by LyX, to "autosave" the current buffer.
4361 \begin_layout Description
4362 Syntax buffer-auto-save
4365 \begin_layout Subsection*
4368 \begin_layout Description
4369 Action Loads the given child document.
4371 \begin_layout Description
4372 Notion The current document is treated as a parent.
4374 \begin_layout Description
4375 Syntax buffer-child-open <FILE>
4377 \begin_layout Description
4378 Params <FILE>: Filename of the child. The directory of the parent is assumed by default.
4380 \begin_layout Description
4381 Origin Ale, 28 May 1997
4384 \begin_layout Subsection*
4387 \begin_layout Description
4388 Action Runs chktex for the current document.
4390 \begin_layout Description
4391 Syntax buffer-chktex
4393 \begin_layout Description
4394 Origin Asger, 30 Oct 1997
4397 \begin_layout Subsection*
4400 \begin_layout Description
4401 Action Closes the current buffer.
4403 \begin_layout Description
4404 Notion Closes the current buffer, asking whether to save it, etc, if the buffer has been modified.
4406 \begin_layout Description
4410 \begin_layout Subsection*
4413 \begin_layout Description
4414 Action Closes all buffers.
4416 \begin_layout Description
4417 Notion Closes all buffers, asking whether to save it, etc, if a buffer has been modified.
4419 \begin_layout Description
4420 Syntax buffer-close-all
4423 \begin_layout Subsection*
4426 \begin_layout Description
4427 Action Exports the current buffer (document) to the given format.
4429 \begin_layout Description
4430 Syntax buffer-export <FORMAT> [<DEST>]
4432 \begin_layout Description
4433 Params <FORMAT> is either "custom" or one of the formats which you can find in Tools->Preferences->File formats->Format. Usual format you will enter is "pdf2" (pdflatex), "pdflatex" (plain tex for pdflatex) or "ps" for postscript.
4434 \begin_inset Newline newline
4437 In case of "custom" you will be asked for a format you want to start from and for the command that you want to apply to this format. Internally the control is then passed to LFUN_BUFFER_EXPORT_CUSTOM. <DEST> If present, this argument provides the export destination filename. Its containing folder will also be the destination folder, where all the needed external files will be copied.
4439 \begin_layout Description
4440 Origin Lgb, 29 Jul 1997
4443 \begin_layout Subsection*
4446 \begin_layout Description
4447 Action Opens a dialog for exporting the current buffer.
4449 \begin_layout Description
4450 Syntax buffer-export-as [<FORMAT>]
4452 \begin_layout Description
4453 Params <FORMAT> is the export format initially selected in the dialog. You can pass any of the formats which you can find in Tools->Preferences->File formats->Format, provided it has the "document" flag set. If no format is specified the dialog will start with the default output format of the current document.
4455 \begin_layout Description
4456 Sample buffer-export-as pdf2
4458 \begin_layout Description
4459 Origin tommaso, 6 Oct 2011
4462 \begin_layout Subsection*
4463 buffer-export-custom
4465 \begin_layout Description
4466 Action Exports the current buffer (document) from the given format using the given command on it.
4468 \begin_layout Description
4469 Syntax buffer-export-custom <FORMAT> <COMMAND>
4471 \begin_layout Description
4472 Params <FORMAT> format to start from (LyX will care to produce such intermediate file).
4473 \begin_inset Newline newline
4476 <COMMAND> this command will be launched on the file. Note that you can use "$$FName" string to qualify the intermediate file.
4478 \begin_layout Description
4479 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
4481 \begin_layout Description
4482 Origin leeming, 27 Mar 2004
4485 \begin_layout Subsection*
4488 \begin_layout Description
4489 Action Applies a command to all non-hidden buffers.
4491 \begin_layout Description
4492 Notion a buffer is `hidden' if it is internally open in LyX, but not visible in any window.
4494 \begin_layout Description
4495 Syntax buffer-forall <LFUN-COMMAND>
4497 \begin_layout Description
4498 Params <LFUN-COMMAND>: The command to be applied to the buffers.
4500 \begin_layout Description
4501 Sample Close all Notes in buffers:
4502 \begin_inset Newline newline
4505 buffer-forall inset-forall Note inset-toggle close
4506 \begin_inset Newline newline
4509 Toggle change tracking on buffers:
4510 \begin_inset Newline newline
4513 buffer-forall changes-track
4514 \begin_inset Newline newline
4517 Toggle read-only for buffers:
4518 \begin_inset Newline newline
4521 buffer-forall buffer-toggle-read-only
4522 \begin_inset Newline newline
4525 Show statistics for individual buffers:
4526 \begin_inset Newline newline
4529 buffer-forall statistics
4530 \begin_inset Newline newline
4533 Activate the branch named "Solutions" in buffers:
4534 \begin_inset Newline newline
4537 buffer-forall branch-activate Solutions
4538 \begin_inset Newline newline
4541 Export buffers to PDF (pdflatex):
4542 \begin_inset Newline newline
4545 buffer-forall buffer-export pdf2
4546 \begin_inset Newline newline
4551 \begin_layout Description
4552 Origin skostysh, 20 Jul 2012
4555 \begin_layout Subsection*
4558 \begin_layout Description
4559 Action Import a given file as a lyx document.
4561 \begin_layout Description
4562 Notion File can be imported iff lyx file format is (transitively) reachable via defined converters in preferences. Look in the File->Import menu to get an idea of the currently active import formats.
4564 \begin_layout Description
4565 Syntax buffer-import <FORMAT> [<FILE>]
4567 \begin_layout Description
4568 Origin Asger, 24 Jul 1998
4571 \begin_layout Subsection*
4574 \begin_layout Description
4575 Action Set language of the current document.
4577 \begin_layout Description
4578 Syntax buffer-language <LANG>
4580 \begin_layout Description
4581 Params <LANG>: language name. See lib/languages for list.
4583 \begin_layout Description
4584 Origin leeming, 30 Mar 2004
4587 \begin_layout Subsection*
4590 \begin_layout Description
4591 Action Moves the current tab one spot to the right.
4593 \begin_layout Description
4594 Syntax buffer-move-next
4596 \begin_layout Description
4597 Origin skostysh, 7 Apr 2015
4600 \begin_layout Subsection*
4601 buffer-move-previous
4603 \begin_layout Description
4604 Action Moves the current tab one spot to the left.
4606 \begin_layout Description
4607 Syntax buffer-move-previous
4609 \begin_layout Description
4610 Origin skostysh, 7 Apr 2015
4613 \begin_layout Subsection*
4616 \begin_layout Description
4617 Action Creates a new buffer (that is, document) and switches to it.
4619 \begin_layout Description
4620 Notion Implicit path can be set in Preferences dialog.
4622 \begin_layout Description
4623 Syntax buffer-new [<FILE>]
4625 \begin_layout Description
4626 Params <FILE>: filename of created file with absolute path.
4629 \begin_layout Subsection*
4632 \begin_layout Description
4633 Action Creates a new buffer (that is, document) from a template.
4635 \begin_layout Description
4636 Notion Path for new files and templates can be set in Preferences dialog. Template will be asked for via Open-dialog.
4638 \begin_layout Description
4639 Syntax buffer-new-template [<FILE>]
4641 \begin_layout Description
4642 Params <FILE>: filename of created file with absolute path.
4645 \begin_layout Subsection*
4648 \begin_layout Description
4649 Action Switch to the next opened document.
4651 \begin_layout Description
4652 Notion Note that this does not necessarily mean next in tabbar (for full list see View menu).
4654 \begin_layout Description
4658 \begin_layout Subsection*
4661 \begin_layout Description
4662 Action Apply the given settings to the current document.
4664 \begin_layout Description
4665 Syntax buffer-params-apply [<ARGS>]
4667 \begin_layout Description
4668 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
4670 \begin_layout Description
4671 Origin leeming, 30 Mar 2004
4674 \begin_layout Subsection*
4677 \begin_layout Description
4678 Action Switch to the previous opened document.
4680 \begin_layout Description
4681 Syntax buffer-previous
4684 \begin_layout Subsection*
4687 \begin_layout Description
4688 Action Reverts opened document.
4690 \begin_layout Description
4691 Syntax buffer-reload
4693 \begin_layout Description
4694 Origin Asger, 2 Feb 1997
4697 \begin_layout Subsection*
4698 buffer-save-as-default
4700 \begin_layout Description
4701 Action Save the current document settings as default.
4703 \begin_layout Description
4704 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
4706 \begin_layout Description
4707 Syntax buffer-save-as-default [<ARGS>]
4709 \begin_layout Description
4710 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
4712 \begin_layout Description
4713 Origin leeming, 30 Mar 2004
4716 \begin_layout Subsection*
4719 \begin_layout Description
4720 Action Display and switch to the given buffer.
4722 \begin_layout Description
4723 Syntax buffer-switch <BUFFER>
4725 \begin_layout Description
4726 Params <BUFFER>: path and filename of already opened (but possibly hidden) document which is to be shown.
4729 \begin_layout Subsection*
4730 buffer-toggle-compression
4732 \begin_layout Description
4733 Action Toggles compression of the current document on/off.
4735 \begin_layout Description
4736 Syntax buffer-toggle-compression
4738 \begin_layout Description
4739 Origin bpeng, 27 Apr 2006
4742 \begin_layout Subsection*
4743 buffer-toggle-read-only
4745 \begin_layout Description
4746 Action Toggle editing mode of the current document between read/write and read-only.
4748 \begin_layout Description
4749 Notion This function is not allowed if the file is under version control, since read-only flag is often used in version control file locking.
4751 \begin_layout Description
4752 Syntax buffer-toggle-read-only
4754 \begin_layout Description
4755 Origin Lgb, 27 May 1997
4758 \begin_layout Subsection*
4761 \begin_layout Description
4762 Action Exports the current document and put the result into the temporary directory.
4764 \begin_layout Description
4765 Notion In case you are already viewing the exported document (see LFUN_BUFFER_VIEW) the output will be rewritten - updated. This is useful in case your viewer is able to detect such changes (e.g. ghostview for postscript).
4767 \begin_layout Description
4768 Syntax buffer-update [<FORMAT>]
4770 \begin_layout Description
4771 Params <FORMAT>: The format to display, where this is one of the formats defined (in the current GUI) in the Tools>Preferences>File Formats dialog. If no format is given, the default format as specified in the same dialog is used.
4773 \begin_layout Description
4774 Origin Dekel, 5 Aug 2000
4777 \begin_layout Subsection*
4780 \begin_layout Description
4781 Action Displays current buffer in chosen format.
4783 \begin_layout Description
4784 Notion Displays the contents of the current buffer in the chosen format, for example, PDF or DVI. This runs the necessary converter, calls the defined viewer, and so forth.
4786 \begin_layout Description
4787 Syntax buffer-view [<FORMAT>]
4789 \begin_layout Description
4790 Params <FORMAT>: The format to display, where this is one of the formats defined (in the current GUI) in the Tools>Preferences>File Formats dialog. If no format is given, the default format as specified in the same dialog is used.
4793 \begin_layout Subsection*
4796 \begin_layout Description
4797 Action Opens the file that was created from last preview of this buffer.
4799 \begin_layout Description
4800 Notion This LFUN is called by the "Show Output Anyway" button in the LaTeX Errors dialog. It can also be called by the user, which is useful if the document takes a long time to compile, and you just want to see the last previewed version.
4802 \begin_layout Description
4803 Syntax buffer-view-cache
4806 \begin_layout Subsection*
4809 \begin_layout Description
4810 Action Saves the current buffer.
4812 \begin_layout Description
4813 Notion Saves the current buffer to disk, using the filename that is already associated with the buffer, asking for one if none is yet assigned.
4815 \begin_layout Description
4819 \begin_layout Subsection*
4822 \begin_layout Description
4823 Action Save all changed documents.
4825 \begin_layout Description
4826 Syntax buffer-write-all
4828 \begin_layout Description
4829 Origin rgh, gpothier 6 Aug 2007
4832 \begin_layout Subsection*
4835 \begin_layout Description
4836 Action Rename and save current buffer.
4838 \begin_layout Description
4839 Syntax buffer-write-as <FILENAME>
4841 \begin_layout Description
4842 Params <FILENAME>: New name of the buffer/file. A relative path is with respect to the original location of the buffer/file.
4845 \begin_layout Subsection*
4848 \begin_layout Description
4849 Action Increases the zoom of the screen fonts.
4851 \begin_layout Description
4852 Syntax buffer-zoom-in [<ZOOM>]
4854 \begin_layout Description
4855 Params <ZOOM>: The zoom in %, the default is 20.
4857 \begin_layout Description
4858 Origin vfr, 30 Mar 2009
4861 \begin_layout Subsection*
4864 \begin_layout Description
4865 Action Decreases the zoom of the screen fonts.
4867 \begin_layout Description
4868 Syntax buffer-zoom-out [<ZOOM>]
4870 \begin_layout Description
4871 Params <ZOOM>: The zoom in %, the default is 20.
4873 \begin_layout Description
4874 Origin vfr, 30 Mar 2009
4877 \begin_layout Subsection*
4880 \begin_layout Description
4881 Action Generates the code (literate programming).
4883 \begin_layout Description
4884 Notion Latex file with extension
4886 literate_extension is generated. Then LyX invokes
4888 build_command (with a default of ``make'') to generate the code and
4890 build_error_filter to process the compilation error messages.
4891 \begin_inset Newline newline
4894 In case you want to process your literate file with a script, or some other program, just insert in your lyxrc file an entry with:
4895 \begin_inset Newline newline
4900 build_command "my_script my_arguments"
4901 \begin_inset Newline newline
4906 build_error_filter differs from the
4908 literate_error_filter only in that the former will identify error messages from your compiler.
4910 \begin_layout Description
4911 Syntax build-program
4914 \begin_layout Subsection*
4917 \begin_layout Description
4918 Action Open LyX document.
4920 \begin_layout Description
4921 Syntax file-open [<FILE>]
4923 \begin_layout Description
4924 Params <FILE>: Filename to be opened.
4927 \begin_layout Subsection*
4930 \begin_layout Description
4931 Action Open the given help file according to the language setting.
4933 \begin_layout Description
4934 Syntax help-open <FILE>[.lyx]
4936 \begin_layout Description
4937 Params <FILE>: any document from (/usr/share/)doc directory.
4939 \begin_layout Description
4940 Origin Jug, 27 Jun 1999
4943 \begin_layout Subsection*
4946 \begin_layout Description
4947 Action Terminates the current LyX instance.
4949 \begin_layout Description
4950 Notion Terminates the current LyX instance, asking whether to save modified documents, etc.
4952 \begin_layout Description
4956 \begin_layout Subsection*
4957 master-buffer-update
4959 \begin_layout Description
4960 Action Update (export) the document built from the master buffer, if the current buffer is part of a master/child document.
4962 \begin_layout Description
4963 Syntax master-buffer-update [<FORMAT>]
4965 \begin_layout Description
4966 Params <FORMAT>: The format to display, where this is one of the formats defined (in the current GUI) in the Tools>Preferences>File Formats dialog. If no format is given, the default format as specified in the same dialog is used.
4968 \begin_layout Description
4969 Origin Tommaso, 20 Sep 2007
4972 \begin_layout Subsection*
4975 \begin_layout Description
4976 Action Show a preview built from the master buffer, if available. if the current buffer is part of a master/child document.
4978 \begin_layout Description
4979 Syntax master-buffer-view [<FORMAT>]
4981 \begin_layout Description
4982 Params <FORMAT>: The format to display, where this is one of the formats defined (in the current GUI) in the Tools>Preferences>File Formats dialog. If no format is given, the default format as specified in the same dialog is used.
4984 \begin_layout Description
4985 Origin Tommaso, 20 Sep 2007
4988 \begin_layout Subsection*
4991 \begin_layout Description
4992 Action Opens the menu given by its name.
4994 \begin_layout Description
4995 Syntax menu-open <NAME>
4997 \begin_layout Description
4998 Params <NAME>: menu name. See various .inc files in lib/ui for candidates.
5001 \begin_layout Subsection*
5004 \begin_layout Description
5005 Action Close the current tab group.
5007 \begin_layout Description
5008 Notion This only closes the work areas, not the buffers themselves. The still opened buffers can be visualized in another tab group.
5010 \begin_layout Description
5011 Syntax tab-group-close
5013 \begin_layout Description
5014 Origin Abdel, 21 Feb 2008
5017 \begin_layout Subsection*
5020 \begin_layout Description
5021 Action Toggles visibility of a given toolbar between on/off/auto.
5023 \begin_layout Description
5024 Notion Skipping "auto" when allowauto is false.
5026 \begin_layout Description
5027 Syntax toolbar-toggle <NAME> [allowauto]
5029 \begin_layout Description
5030 Params <NAME>: standard|extra|table|math|mathmacrotemplate|
5031 \begin_inset Newline newline
5034 minibuffer|review|view/update|math_panels|vcs| view-others|update-others
5036 \begin_layout Description
5037 Origin Edwin, 21 May 2007
5040 \begin_layout Subsection*
5043 \begin_layout Description
5044 Action Various UI visibility-toggling actions.
5046 \begin_layout Description
5047 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
5049 \begin_layout Description
5050 Params statusbar : Toggle visibility of the statusbar.
5051 \begin_inset Newline newline
5054 menubar : Toggle visibility of the menubar.
5055 \begin_inset Newline newline
5058 scrollbar : Toggle visibility of the scrollbar.
5059 \begin_inset Newline newline
5062 frame : Toggle visibility of the frames around editing window.
5063 \begin_inset Newline newline
5066 fullscreen : Toggle fullscreen mode. This also covers calling the previous functions. However LFUN_TOOLBAR_TOGGLE for the custom tweaks of the toolbars should be used.
5068 \begin_layout Description
5069 Origin sanda, 9 Feb 2007
5072 \begin_layout Subsection*
5075 \begin_layout Description
5076 Action Close the current document work area.
5078 \begin_layout Description
5079 Notion Close the current work area. If no other work areas are showing the buffer, then close the associated buffer as well.
5081 \begin_layout Description
5084 \begin_layout Description
5085 Origin Tommaso, 15 Sep 2012
5088 \begin_layout Subsection*
5091 \begin_layout Description
5092 Action Creates another split view of current buffer.
5094 \begin_layout Description
5095 Notion All split views act in the same way independently.
5097 \begin_layout Description
5098 Syntax view-split <vertical|horizontal>
5100 \begin_layout Description
5101 Params horizontal : The work areas are laid out side by side.
5102 \begin_inset Newline newline
5105 vertical : The work areas laid out vertically.
5107 \begin_layout Description
5108 Origin Abdel, 20 Feb 2008
5111 \begin_layout Subsection*
5114 \begin_layout Description
5115 Action Closes the current LyX window.
5117 \begin_layout Description
5120 \begin_layout Description
5121 Origin Abdel, 23 Oct 2006
5124 \begin_layout Subsection*
5127 \begin_layout Description
5128 Action Creates new empty LyX window.
5130 \begin_layout Description
5131 Notion Already opened documents from the previous window can be found under View menu.
5133 \begin_layout Description
5134 Syntax window-new [<GEOMETRY>]
5136 \begin_layout Description
5137 Params <GEOMETRY>: pass the geometry of the window. This parameter is currently accepted only on Windows platform.
5139 \begin_layout Description
5140 Origin Abdel, 21 Oct 2006
5143 \begin_layout Section
5144 System Functions (Preferences, LyX Server etc.)
5146 \begin_layout Subsection*
5147 buffer-toggle-output-sync
5149 \begin_layout Description
5150 Action Toggles including of resources for forward/reverse search of the given document.
5152 \begin_layout Description
5153 Notion When toggled on, SyncTeX is invoked for PDF, while srcltx package is used for DVI. Custom LaTeX macro can be defined in preferences.
5155 \begin_layout Description
5156 Syntax buffer-toggle-output-sync
5158 \begin_layout Description
5159 Origin sanda, 25 May 2010
5162 \begin_layout Subsection*
5165 \begin_layout Description
5166 Action Executes a command defined in a .def file.
5168 \begin_layout Description
5169 Notion The definitions are by default read from lib/commands/default.def.
5170 \begin_inset Newline newline
5173 A .def file allows to define a command with
5175 define "<NAME>" "<LFUN>" where <NAME> is the name of the new command and <LFUN> is the lfun code to be executed (see e.g. LFUN_COMMAND_SEQUENCE).
5177 def_file "FileName" allows to include another .def file.
5178 \begin_inset Newline newline
5181 This is particularly useful in connection with toolbar buttons: Since the name of the button image for this lfun is lib/images/commands/<NAME>.png this is the way to assign an image to a complex command-sequence.
5183 \begin_layout Description
5186 \begin_layout Description
5187 Params <NAME>: Name of the command that must be called.
5189 \begin_layout Description
5190 Origin broider, 2 Oct 2007
5193 \begin_layout Subsection*
5196 \begin_layout Description
5197 Action Cancels sequence prepared by LFUN_META_PREFIX .
5199 \begin_layout Description
5203 \begin_layout Subsection*
5204 command-alternatives
5206 \begin_layout Description
5207 Action Runs the first listed command that is enabled.
5209 \begin_layout Description
5210 Notion This can be used to bind multiple functions to a single key, and then which one is used will depend upon the context.
5212 \begin_layout Description
5213 Syntax command-alternatives <CMDS>
5215 \begin_layout Description
5216 Params <CMDS>: Sequence of commands separated by semicolons.
5218 \begin_layout Description
5219 Sample command-alternatives completion-accept;cell-forward
5221 \begin_layout Description
5222 Origin rgh, 24 September 2008
5225 \begin_layout Subsection*
5228 \begin_layout Description
5229 Action Run more commands (LFUN and its parameters) in a sequence.
5231 \begin_layout Description
5232 Syntax command-sequence <CMDS>
5234 \begin_layout Description
5235 Params <CMDS>: Sequence of commands separated by semicolons.
5237 \begin_layout Description
5238 Sample command-sequence cut; ert-insert; self-insert
5240 ; paste; self-insert {}; inset-toggle;
5242 \begin_layout Description
5243 Origin Andre, 11 Nov 1999
5246 \begin_layout Subsection*
5247 cursor-follows-scrollbar-toggle
5249 \begin_layout Description
5250 Action Determine whether to keep cursor inside the editing window regardless of the scrollbar movement.
5252 \begin_layout Description
5253 Syntax toggle-cursor-follows-scrollbar
5255 \begin_layout Description
5256 Origin ARRae, 2 Dec 1997
5259 \begin_layout Subsection*
5262 \begin_layout Description
5263 Action Set debug output level.
5265 \begin_layout Description
5266 Syntax debug-level-set <LEVEL>
5268 \begin_layout Description
5269 Params <LEVEL>: comma separated list of levels or the correspondent number of their combination. 0 is equivalent to disabling all debug events. See lyx -dbg for the current list of debug levels and their numbers.
5271 \begin_layout Description
5272 Origin sanda, 28 Dec 2009
5275 \begin_layout Subsection*
5278 \begin_layout Description
5279 Action Sets the cursor position in the previewed (dvi/pdf) file based on the row number in LyX window.
5281 \begin_layout Description
5282 Notion The external program used for forward search call can be specified in LyX Output preferences. See Additional manual for details of these settings.
5284 \begin_layout Description
5285 Syntax forward-search
5287 \begin_layout Description
5288 Origin sanda, 14 Apr 2010
5291 \begin_layout Subsection*
5294 \begin_layout Description
5295 Action Apply the given settings to user preferences.
5297 \begin_layout Description
5298 Syntax lyxrc-apply <SETTINGS>
5300 \begin_layout Description
5301 Params <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences to get an idea which commands to use and their syntax. lyx::LyXRC::LyXRCTags has the list of possible commands.
5304 \begin_layout Subsection*
5307 \begin_layout Description
5308 Action Shows message in statusbar (for script purposes).
5310 \begin_layout Description
5311 Syntax message <STRING>
5313 \begin_layout Description
5314 Origin Lgb, 8 Apr 2001
5317 \begin_layout Subsection*
5320 \begin_layout Description
5321 Action Simulate halting Meta key (Alt key on PCs).
5323 \begin_layout Description
5324 Notion Used for buffer edition not for GUI control.
5326 \begin_layout Description
5330 \begin_layout Subsection*
5333 \begin_layout Description
5334 Action Save user preferences.
5336 \begin_layout Description
5337 Syntax preferences-save
5339 \begin_layout Description
5340 Origin Lgb, 27 Nov 1999
5343 \begin_layout Subsection*
5346 \begin_layout Description
5347 Action Reconfigure the automatic settings.
5349 \begin_layout Description
5352 \begin_layout Description
5353 Origin Asger, 14 Feb 1997
5356 \begin_layout Subsection*
5359 \begin_layout Description
5360 Action Returns path and file name of the currently edited document.
5362 \begin_layout Description
5363 Syntax server-get-filename
5366 \begin_layout Subsection*
5369 \begin_layout Description
5370 Action Returns the current layout (that is environment) name on the cursor position.
5372 \begin_layout Description
5373 Syntax server-get-layout
5376 \begin_layout Subsection*
5377 server-get-statistics
5379 \begin_layout Description
5380 Action Returns the statistics (number of words and characters) in the document or in the given selection.
5382 \begin_layout Description
5383 Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
5385 \begin_layout Description
5386 Syntax server-get-statistics [<TYPE>]
5388 \begin_layout Description
5389 Params <TYPE>: <words|chars|chars-space> The requested count; if not specified, the three values are returned, separated by a space.
5390 \begin_inset Newline newline
5394 \begin_inset Newline newline
5397 chars: count characters.
5398 \begin_inset Newline newline
5401 chars-space: count characters and spaces.
5403 \begin_layout Description
5404 Origin brokenclock, Oct 10 2014
5407 \begin_layout Subsection*
5410 \begin_layout Description
5411 Action Returns the coordinates of cursor position in the editing area.
5413 \begin_layout Description
5414 Syntax server-get-xy
5417 \begin_layout Subsection*
5418 server-goto-file-row
5420 \begin_layout Description
5421 Action Sets the cursor position in LyX based on the row number of generated TeX file.
5423 \begin_layout Description
5424 Notion This can be useful for DVI inverse-search or detection of the problematic line from LaTeX compilation. Note that before this function can be used export to LaTeX output must occur (in order to map the row numbers).
5426 \begin_layout Description
5427 Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
5429 \begin_layout Description
5430 Params <FILE>: the path and filename. Environment variables are expanded in the path. In case this LFUN does not work make sure you are giving correct path to the file.
5431 \begin_inset Newline newline
5434 If the file is located inside LyX temporary directory it will be mapped back into the appropriate opened buffer (e.g. for the case of generated .tex file).
5435 \begin_inset Newline newline
5438 .ext: extensions will be automatically replaced by .lyx.
5439 \begin_inset Newline newline
5442 <ROW_NUMBER> The row number of the LaTeX file to which to go.
5444 \begin_layout Description
5445 Sample server-goto-file-row /home/user/example.lyx 41
5446 \begin_inset Newline newline
5449 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
5451 \begin_layout Description
5452 Origin Edmar, 23 Dec 1998
5455 \begin_layout Subsection*
5458 \begin_layout Description
5459 Action Sends notify message about the last key-sequence to client.
5461 \begin_layout Description
5462 Notion This can be used to grab last key-sequence used inside the LyX window. See also Debug extensions section in Additional features manual.
5464 \begin_layout Description
5465 Syntax server-notify
5468 \begin_layout Subsection*
5471 \begin_layout Description
5472 Action Sets the cursor position based on the editing area coordinates (similar to clicking on that point with left mouse button).
5474 \begin_layout Description
5475 Syntax server-set-xy <X> <Y>
5478 \begin_layout Subsection*
5481 \begin_layout Description
5482 Action Set the given LyX color to the color defined by the X11 name given.
5484 \begin_layout Description
5485 Notion A new color entry is created if the color is unknown. Color names can be stored as a part of user settings.
5487 \begin_layout Description
5488 Syntax set-color <LYX_NAME> <X11_NAME>
5490 \begin_layout Description
5491 Origin SLior, 11 Jun 2000
5494 \begin_layout Subsection*
5497 \begin_layout Description
5498 Action Count the statistics (number of words and characters) in the document or in the given selection and display it in a dialog box.
5500 \begin_layout Description
5501 Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
5503 \begin_layout Description
5506 \begin_layout Description
5507 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
5510 \begin_layout Subsection*
5513 \begin_layout Description
5514 Action Checks-in/commits the changes of the registered file to the repository.
5516 \begin_layout Description
5517 Notion In RCS case this also unlocks the file.
5519 \begin_layout Description
5522 \begin_layout Description
5523 Origin Lgb, 1 Jul 1997
5526 \begin_layout Subsection*
5529 \begin_layout Description
5530 Action Checks-out the document for edit (and locks it in some cases).
5532 \begin_layout Description
5535 \begin_layout Description
5536 Origin Lgb, 1 Jul 1997
5539 \begin_layout Subsection*
5542 \begin_layout Description
5543 Action Executes external command. This command is intended to support additional VCS commands.
5545 \begin_layout Description
5546 Syntax vc-command <FLAG> <PATH> <COMMAND>
5548 \begin_layout Description
5549 Params <FLAG>: Flags for the command can be combined together.
5550 \begin_inset Newline newline
5553 U - dUmmy - no flags
5554 \begin_inset Newline newline
5557 D - Doc - need document loaded to proceed
5558 \begin_inset Newline newline
5561 I - dIrty - mark document dirty
5562 \begin_inset Newline newline
5565 R - Reload - ensure that the document is saved and reload it after command execution
5566 \begin_inset Newline newline
5569 M - Message - ask for input string (commit message)
5570 \begin_inset Newline newline
5573 <PATH>: path where to start. $$p will be replaced by the current document path.
5574 \begin_inset Newline newline
5577 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current document(with absolute path)/path/message.
5579 \begin_layout Description
5580 Sample vc-command DR $$p "svn up"
5582 \begin_layout Description
5583 Origin sanda, 13 Jan 2009
5586 \begin_layout Subsection*
5589 \begin_layout Description
5590 Action Compares two revisions of the same file under version control.
5592 \begin_layout Description
5593 Syntax vc-compare [<REV1>] [<REV2>]
5595 \begin_layout Description
5596 Params Revision number either points directly to commit in history or if negative number -x it points to (last commit - x).
5597 \begin_inset Newline newline
5600 In RCS we subtract only in the last number of revision specification. Special case "0" is reserved for the last committed revision.
5601 \begin_inset Newline newline
5605 \begin_inset Newline newline
5608 <REV2>: Newer file. Used only if REV1 > 0.
5609 \begin_inset Newline newline
5612 If no parameter is given, interactive dialog will be shown.
5614 \begin_layout Description
5615 Sample Compare current document against last commit
5616 \begin_inset Newline newline
5620 \begin_inset Newline newline
5623 Compare current document against current revision - 5 commits
5624 \begin_inset Newline newline
5628 \begin_inset Newline newline
5631 Compare revisions 120 and 155
5632 \begin_inset Newline newline
5637 \begin_layout Description
5638 Origin sanda, 12 Feb 2010
5641 \begin_layout Subsection*
5644 \begin_layout Description
5645 Action Copies the document to another name.
5647 \begin_layout Description
5648 Notion Copying with revision history is only supported by SVN. For RCS and CVS it is simulated by adding the document under a new name. Disabled if uncommitted changes exist.
5650 \begin_layout Description
5651 Syntax vc-copy <FILENAME>
5653 \begin_layout Description
5654 Params <FILENAME>: New name of the document.
5655 \begin_inset Newline newline
5658 A file dialog is opened if no filename is given.
5660 \begin_layout Description
5661 Origin gb, 05 Feb 2013
5664 \begin_layout Subsection*
5667 \begin_layout Description
5668 Action Toggles the locking property of the edited file.
5670 \begin_layout Description
5671 Notion This is currently implemented only for SVN.
5673 \begin_layout Description
5674 Syntax vc-locking-toggle
5676 \begin_layout Description
5677 Origin sanda, 25 Jun 2009
5680 \begin_layout Subsection*
5683 \begin_layout Description
5684 Action Register the document as an file inside version control system.
5686 \begin_layout Description
5687 Notion File is registered inside cvs, svn or rcs repository acording to the existence of cvs/svn/rcs entries in the document's directory.
5688 \begin_inset Newline newline
5691 See LyX Additional Features Manual (Version Control Chapter) for additional information.
5693 \begin_layout Description
5696 \begin_layout Description
5697 Origin Lgb, 1 Jul 1997
5700 \begin_layout Subsection*
5703 \begin_layout Description
5704 Action Renames the document to another name.
5706 \begin_layout Description
5707 Notion Renaming with revision history is only supported by SVN. For CVS it is simulated by adding the document under a new name and deleting the old one. For RCS it is not supported. Disabled if uncommitted changes exist.
5709 \begin_layout Description
5710 Syntax vc-rename <FILENAME>
5712 \begin_layout Description
5713 Params <FILENAME>: New name of the document.
5714 \begin_inset Newline newline
5717 A file dialog is opened if no filename is given.
5719 \begin_layout Description
5720 Origin gb, 05 Feb 2013
5723 \begin_layout Subsection*
5726 \begin_layout Description
5727 Action Update the local archive directory in which resides the current document with the remote repository.
5729 \begin_layout Description
5730 Syntax vc-repo-update
5732 \begin_layout Description
5733 Origin sanda, 16 Oct 2009
5736 \begin_layout Subsection*
5739 \begin_layout Description
5740 Action Reverts the document to the last check-in/commit in VCS.
5742 \begin_layout Description
5745 \begin_layout Description
5746 Origin Lgb, 1 Jul 1997
5749 \begin_layout Subsection*
5752 \begin_layout Description
5753 Action Undo last check-in.
5755 \begin_layout Description
5756 Notion This is currently implemented only for RCS.
5758 \begin_layout Description
5761 \begin_layout Description
5762 Origin Lgb, 1 Jul 1997
5765 \begin_layout Section
5766 Hidden Functions (not listed for configuration)
5768 \begin_layout Subsection*
5771 \begin_layout Description
5772 Action Return the current key sequence and available options as a string.
5774 \begin_layout Description
5775 Notion No options are added if no current map exists.
5776 \begin_inset Newline newline
5779 This is probably usable only with connection to lyxserver.
5781 \begin_layout Description
5782 Syntax command-prefix
5785 \begin_layout Subsection*
5788 \begin_layout Description
5789 Action Inserts the given string (accordingly to the correct keymap).
5791 \begin_layout Description
5792 Notion Automatically replace the currently selected text. Depends on lyxrc settings "auto_region_delete".
5794 \begin_layout Description
5795 Syntax self-insert <STRING>