]> git.lyx.org Git - lyx.git/blob - lib/doc/LFUNs.lyx
c11f7234d969afca3453aa75d7f583d96051eaf7
[lyx.git] / lib / doc / LFUNs.lyx
1 # gen_lfuns.py generated this file. For more info see http://www.lyx.org/
2 \lyxformat 345
3 \begin_document
4 \begin_header
5 \textclass amsart
6 \use_default_options false
7 \begin_modules
8 theorems-ams
9 \end_modules
10 \language english
11 \inputencoding auto
12 \font_roman default
13 \font_sans default
14 \font_typewriter default
15 \font_default_family default
16 \font_sc false
17 \font_osf false
18 \font_sf_scale 100
19 \font_tt_scale 100
20
21 \graphics default
22 \paperfontsize default
23 \use_hyperref false
24 \papersize default
25 \use_geometry true
26 \use_amsmath 1
27 \use_esint 1
28 \cite_engine basic
29 \use_bibtopic false
30 \paperorientation portrait
31 \leftmargin 2.5cm
32 \topmargin 2cm
33 \rightmargin 3cm
34 \bottommargin 1cm
35 \secnumdepth 3
36 \tocdepth 3
37 \paragraph_separation indent
38 \defskip medskip
39 \quotes_language english
40 \papercolumns 1
41 \papersides 1
42 \paperpagestyle default
43 \tracking_changes false
44 \output_changes false
45 \author "" 
46 \author "" 
47 \end_header
48
49 \begin_body
50
51 \begin_layout Section*
52 LFUNs documentation automatically generated 2009-06-12
53 \end_layout
54
55 \begin_layout Standard
56 \begin_inset ERT
57 status collapsed
58
59 \begin_layout Plain Layout
60
61
62 \backslash
63 thispagestyle{empty}
64 \end_layout
65
66 \end_inset
67
68
69 \begin_inset VSpace 1cm
70 \end_inset
71
72
73 \end_layout
74 \begin_layout Subsection*
75 LFUN_ACCENT_ACUTE
76 \end_layout
77 \begin_layout Description
78 Action Adds an acute accent to the next character typed.
79 \end_layout
80 \begin_layout Description
81 Syntax accent-acute
82 \end_layout
83
84 \begin_layout Subsection*
85 LFUN_ACCENT_BREVE
86 \end_layout
87 \begin_layout Description
88 Action Adds a breve accent to the next character typed.
89 \end_layout
90 \begin_layout Description
91 Syntax accent-breve
92 \end_layout
93
94 \begin_layout Subsection*
95 LFUN_ACCENT_CARON
96 \end_layout
97 \begin_layout Description
98 Action Adds a caron to the next character typed.
99 \end_layout
100 \begin_layout Description
101 Syntax accent-caron
102 \end_layout
103
104 \begin_layout Subsection*
105 LFUN_ACCENT_CEDILLA
106 \end_layout
107 \begin_layout Description
108 Action Adds a cedilla to the next character typed.
109 \end_layout
110 \begin_layout Description
111 Syntax accent-cedilla
112 \end_layout
113
114 \begin_layout Subsection*
115 LFUN_ACCENT_CIRCLE
116 \end_layout
117 \begin_layout Description
118 Action Adds a circle accent to the next character typed.
119 \end_layout
120 \begin_layout Description
121 Syntax accent-circle
122 \end_layout
123
124 \begin_layout Subsection*
125 LFUN_ACCENT_CIRCUMFLEX
126 \end_layout
127 \begin_layout Description
128 Action Adds a circumflex to the next character typed.
129 \end_layout
130 \begin_layout Description
131 Syntax accent-circumflex
132 \end_layout
133
134 \begin_layout Subsection*
135 LFUN_ACCENT_DOT
136 \end_layout
137 \begin_layout Description
138 Action Adds a dot accent to the next character typed.
139 \end_layout
140 \begin_layout Description
141 Syntax accent-dot
142 \end_layout
143
144 \begin_layout Subsection*
145 LFUN_ACCENT_GRAVE
146 \end_layout
147 \begin_layout Description
148 Action Adds a grave accent to the next character typed.
149 \end_layout
150 \begin_layout Description
151 Syntax accent-grave
152 \end_layout
153
154 \begin_layout Subsection*
155 LFUN_ACCENT_HUNGARIAN_UMLAUT
156 \end_layout
157 \begin_layout Description
158 Action Adds a Hungarian umlaut to the next character typed.
159 \end_layout
160 \begin_layout Description
161 Syntax accent-grave
162 \end_layout
163
164 \begin_layout Subsection*
165 LFUN_ACCENT_MACRON
166 \end_layout
167 \begin_layout Description
168 Action Adds a macron to the next character typed.
169 \end_layout
170 \begin_layout Description
171 Syntax accent-macron
172 \end_layout
173
174 \begin_layout Subsection*
175 LFUN_ACCENT_OGONEK
176 \end_layout
177 \begin_layout Description
178 Action Adds an ogonek accent to the next character typed.
179 \end_layout
180 \begin_layout Description
181 Syntax accent-ogonek
182 \end_layout
183
184 \begin_layout Subsection*
185 LFUN_ACCENT_TIE
186 \end_layout
187 \begin_layout Description
188 Action Adds a tie over the next two character typed.
189 \end_layout
190 \begin_layout Description
191 Notion The following char will finish the tie.
192 \end_layout
193 \begin_layout Description
194 Syntax accent-tie
195 \end_layout
196
197 \begin_layout Subsection*
198 LFUN_ACCENT_TILDE
199 \end_layout
200 \begin_layout Description
201 Action Adds a tilde over the next character typed.
202 \end_layout
203 \begin_layout Description
204 Syntax accent-tilde
205 \end_layout
206
207 \begin_layout Subsection*
208 LFUN_ACCENT_UMLAUT
209 \end_layout
210 \begin_layout Description
211 Action Adds an umlaut over the next character typed.
212 \end_layout
213 \begin_layout Description
214 Syntax accent-umlaut
215 \end_layout
216
217 \begin_layout Subsection*
218 LFUN_ACCENT_UNDERBAR
219 \end_layout
220 \begin_layout Description
221 Action Adds a bar under the next character typed.
222 \end_layout
223 \begin_layout Description
224 Syntax accent-underbar
225 \end_layout
226
227 \begin_layout Subsection*
228 LFUN_ACCENT_UNDERDOT
229 \end_layout
230 \begin_layout Description
231 Action Adds a dot under the next character typed.
232 \end_layout
233 \begin_layout Description
234 Syntax accent-underdot
235 \end_layout
236
237 \begin_layout Subsection*
238 LFUN_CAPTION_INSERT
239 \end_layout
240 \begin_layout Description
241 Action Inserts a caption inset.
242 \end_layout
243 \begin_layout Description
244 Syntax caption-insert
245 \end_layout
246 \begin_layout Description
247 Origin Lgb, 18 Jul 2000
248 \end_layout
249
250 \begin_layout Subsection*
251 LFUN_DATE_INSERT
252 \end_layout
253 \begin_layout Description
254 Action Inserts the current date.
255 \end_layout
256 \begin_layout Description
257 Syntax date-insert [<ARG>]
258 \end_layout
259 \begin_layout Description
260 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.
261 \end_layout
262 \begin_layout Description
263 Origin jdblair, 31 Jan 2000
264 \end_layout
265
266 \begin_layout Subsection*
267 LFUN_FOOTNOTE_INSERT
268 \end_layout
269 \begin_layout Description
270 Action Inserts a footnote inset.
271 \end_layout
272 \begin_layout Description
273 Syntax footnote-insert
274 \end_layout
275 \begin_layout Description
276 Origin Jug, 7 Mar 2000
277 \end_layout
278
279 \begin_layout Subsection*
280 LFUN_ERT_INSERT
281 \end_layout
282 \begin_layout Description
283 Action Inserts an ERT inset.
284 \end_layout
285 \begin_layout Description
286 Syntax ert-insert
287 \end_layout
288 \begin_layout Description
289 Origin Jug, 18 Feb 2000
290 \end_layout
291
292 \begin_layout Subsection*
293 LFUN_FLOAT_INSERT
294 \end_layout
295 \begin_layout Description
296 Action Inserts a float inset.
297 \end_layout
298 \begin_layout Description
299 Syntax float-insert <TYPE>
300 \end_layout
301 \begin_layout Description
302 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
303 \end_layout
304 \begin_layout Description
305 Origin Lgb, 27 Jun 2000
306 \end_layout
307
308 \begin_layout Subsection*
309 LFUN_FLOAT_WIDE_INSERT
310 \end_layout
311 \begin_layout Description
312 Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
313 \end_layout
314 \begin_layout Description
315 Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
316 \end_layout
317 \begin_layout Description
318 Syntax float-wide-insert <TYPE>
319 \end_layout
320 \begin_layout Description
321 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
322 \end_layout
323 \begin_layout Description
324 Origin Lgb, 31 Oct 2001
325 \end_layout
326
327 \begin_layout Subsection*
328 LFUN_FLOAT_LIST_INSERT
329 \end_layout
330 \begin_layout Description
331 Action Inserts the list of floats in the document.
332 \end_layout
333 \begin_layout Description
334 Syntax float-list-insert <TYPE>
335 \end_layout
336 \begin_layout Description
337 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
338 \end_layout
339 \begin_layout Description
340 Origin Lgb, 3 May 2001
341 \end_layout
342
343 \begin_layout Subsection*
344 LFUN_WRAP_INSERT
345 \end_layout
346 \begin_layout Description
347 Action Inserts floats wrapped by the text around.
348 \end_layout
349 \begin_layout Description
350 Syntax wrap-insert <TYPE>
351 \end_layout
352 \begin_layout Description
353 Params <TYPE>: table|figure
354 \end_layout
355 \begin_layout Description
356 Origin Dekel, 7 Apr 2002
357 \end_layout
358
359 \begin_layout Subsection*
360 LFUN_OPTIONAL_INSERT
361 \end_layout
362 \begin_layout Description
363 Action Inserts an optional-argument (short title) inset.
364 \end_layout
365 \begin_layout Description
366 Syntax optional-insert
367 \end_layout
368 \begin_layout Description
369 Origin vermeer, 12 Aug 2002
370 \end_layout
371
372 \begin_layout Subsection*
373 LFUN_LINE_INSERT
374 \end_layout
375 \begin_layout Description
376 Action Inserts a horizontal line.
377 \end_layout
378 \begin_layout Description
379 Syntax line-insert
380 \end_layout
381 \begin_layout Description
382 Origin Andre, Oct 27 2003
383 \end_layout
384
385 \begin_layout Subsection*
386 LFUN_NEWPAGE_INSERT
387 \end_layout
388 \begin_layout Description
389 Action Inserts a new page.
390 \end_layout
391 \begin_layout Description
392 Syntax newpage-insert <ARG>
393 \end_layout
394 \begin_layout Description
395 Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
396 \end_layout
397 \begin_layout Description
398 Origin uwestoehr, 24 Nov 2007
399 \end_layout
400
401 \begin_layout Subsection*
402 LFUN_MARGINALNOTE_INSERT
403 \end_layout
404 \begin_layout Description
405 Action Inserts a marginal note.
406 \end_layout
407 \begin_layout Description
408 Syntax marginalnote-insert
409 \end_layout
410 \begin_layout Description
411 Origin Lgb, 26 Jun 2000
412 \end_layout
413
414 \begin_layout Subsection*
415 LFUN_UNICODE_INSERT
416 \end_layout
417 \begin_layout Description
418 Action Inserts a single unicode character.
419 \end_layout
420 \begin_layout Description
421 Syntax unicode-insert <CHAR>
422 \end_layout
423 \begin_layout Description
424 Params <CHAR>: The character to insert, given as its code point, in hexadecimal.
425 \end_layout
426 \begin_layout Description
427 Sample unicode-insert 0x0100
428 \end_layout
429 \begin_layout Description
430 Origin Lgb, 22 Oct 2006
431 \end_layout
432
433 \begin_layout Subsection*
434 LFUN_LISTING_INSERT
435 \end_layout
436 \begin_layout Description
437 Action Inserts a new listings inset.
438 \end_layout
439 \begin_layout Description
440 Syntax listing-insert
441 \end_layout
442 \begin_layout Description
443 Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
444 \end_layout
445
446 \begin_layout Subsection*
447 LFUN_TAB_INSERT
448 \end_layout
449 \begin_layout Description
450 Action Insert a tab into a listings inset.
451 \end_layout
452 \begin_layout Description
453 Notion It also works on a selection.
454 \end_layout
455 \begin_layout Description
456 Syntax tab-insert
457 \end_layout
458 \begin_layout Description
459 Origin vfr, Sep 30 2008
460 \end_layout
461
462 \begin_layout Subsection*
463 LFUN_TAB_DELETE
464 \end_layout
465 \begin_layout Description
466 Action Delete a tab or up to an equivalent amount of spaces from a listings inset.
467 \end_layout
468 \begin_layout Description
469 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.
470 \end_layout
471 \begin_layout Description
472 Syntax tab-delete
473 \end_layout
474 \begin_layout Description
475 Origin vfr, Sep 30 2008
476 \end_layout
477
478 \begin_layout Subsection*
479 LFUN_QUOTE_INSERT
480 \end_layout
481 \begin_layout Description
482 Action Inserts quotes according to the type and quote-language preference.
483 \end_layout
484 \begin_layout Description
485 Notion Currently English, Swedish, German, Polish, French, Danish quotes are distinguished.
486 \end_layout
487 \begin_layout Description
488 Syntax quote-insert [<TYPE>]
489 \end_layout
490 \begin_layout Description
491 Params <TYPE>: 'single' for single quotes, otherwise double quotes will be used.
492 \end_layout
493
494 \begin_layout Subsection*
495 LFUN_INFO_INSERT
496 \end_layout
497 \begin_layout Description
498 Action Displays shortcuts, lyxrc, package and textclass availability and menu information in a non-editable boxed InsetText.
499 \end_layout
500 \begin_layout Description
501 Notion Apart from lfun arguments you can use the following method:
502 \begin_inset Newline newline
503 \end_inset
504
505 1. input the type and argument of this inset, e.g. "menu paste", in the work area.
506 \begin_inset Newline newline
507 \end_inset
508
509 2. select the text and run info-insert lfun.
510 \end_layout
511 \begin_layout Description
512 Syntax info-insert <TYPE> <ARG>
513 \end_layout
514 \begin_layout Description
515 Params <TYPE>: shortcut|lyxrc|package|textclass|menu|buffer
516 \begin_inset Newline newline
517 \end_inset
518
519 <ARG>: argument for a given type. Look into InsetInfo.h for detailed description.
520 \end_layout
521 \begin_layout Description
522 Sample command-sequence info-insert buffer path; info-insert buffer name
523 \end_layout
524 \begin_layout Description
525 Origin bpeng, 7 Oct 2007
526 \end_layout
527
528 \begin_layout Subsection*
529 LFUN_BRANCH_INSERT
530 \end_layout
531 \begin_layout Description
532 Action Inserts branch inset.
533 \end_layout
534 \begin_layout Description
535 Syntax branch-insert <BRANCH-NAME>
536 \end_layout
537 \begin_layout Description
538 Origin vermeer, 17 Aug 2003
539 \end_layout
540
541 \begin_layout Subsection*
542 LFUN_BOX_INSERT
543 \end_layout
544 \begin_layout Description
545 Action Inserts Box inset.
546 \end_layout
547 \begin_layout Description
548 Syntax box-insert [<TYPE>]
549 \end_layout
550 \begin_layout Description
551 Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
552 \begin_inset Newline newline
553 \end_inset
554
555 Framed is the default one.
556 \end_layout
557 \begin_layout Description
558 Origin vermeer, 7 Oct 2003
559 \end_layout
560
561 \begin_layout Subsection*
562 LFUN_FLEX_INSERT
563 \end_layout
564 \begin_layout Description
565 Action Inserts CharStyle, Custom inset or XML short element.
566 \end_layout
567 \begin_layout Description
568 Notion Look into the Customization manual for more information about these elements.
569 \begin_inset Newline newline
570 \end_inset
571
572 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.
573 \begin_inset Newline newline
574 \end_inset
575
576 For dissolving the element see LFUN_INSET_DISSOLVE.
577 \end_layout
578 \begin_layout Description
579 Syntax flex-insert <TYPE:Name>
580 \end_layout
581 \begin_layout Description
582 Params TYPE: CharStyle|Custom|Element|Standard
583 \begin_inset Newline newline
584 \end_inset
585
586 Identifies whether this is a Character Style, a Custom Inset or an XML Element, and which dynamical sub-menu this flex inset is in on the LyX menu tree. If Standard (currently unused): none of these.
587 \begin_inset Newline newline
588 \end_inset
589
590 Name: This name must be defined either in your layout file or imported by some module. The definition is InsetLayout <TYPE:Name>
591 \end_layout
592 \begin_layout Description
593 Sample flex-insert CharStyle:Code
594 \end_layout
595
596 \begin_layout Subsection*
597 LFUN_SELF_INSERT
598 \end_layout
599 \begin_layout Description
600 Action Inserts the given string (accordingly to the correct keymap).
601 \end_layout
602 \begin_layout Description
603 Notion Automatically replace the currently selected text. Depends on lyxrc settings "auto_region_delete".
604 \end_layout
605 \begin_layout Description
606 Syntax self-insert <STRING>
607 \end_layout
608
609 \begin_layout Subsection*
610 LFUN_SPACE_INSERT
611 \end_layout
612 \begin_layout Description
613 Action Inserts one of horizontal space insets.
614 \end_layout
615 \begin_layout Description
616 Syntax space-insert <NAME> [<LEN>]
617 \end_layout
618 \begin_layout Description
619 Params <NAME>: normal, protected, thin, quad, qquad, enspace, enskip, negthinspace, hfill, hfill*, dotfill, hrulefill, hspace, hspace*
620 \begin_inset Newline newline
621 \end_inset
622
623 <LEN>: length for custom spaces (hspace, hspace* for protected)
624 \end_layout
625 \begin_layout Description
626 Origin JSpitzm, 20 May 2003, Mar 17 2008
627 \end_layout
628
629 \begin_layout Subsection*
630 LFUN_HYPERLINK_INSERT
631 \end_layout
632 \begin_layout Description
633 Action Inserts hyperlinks into the document (clickable in pdf output).
634 \end_layout
635 \begin_layout Description
636 Notion Hyperlink target can be set via selection + hyperlink-insert function.
637 \end_layout
638 \begin_layout Description
639 Syntax href-insert [<TARGET>]
640 \end_layout
641 \begin_layout Description
642 Origin CFO-G, 21 Nov 1997
643 \end_layout
644
645 \begin_layout Subsection*
646 LFUN_SPECIALCHAR_INSERT
647 \end_layout
648 \begin_layout Description
649 Action Inserts various characters into the document.
650 \end_layout
651 \begin_layout Description
652 Syntax specialchar-insert <CHAR>
653 \end_layout
654 \begin_layout Description
655 Params <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots, end-of-sentence, menu-separator.
656 \end_layout
657 \begin_layout Description
658 Origin JSpitzm, 6 Dec 2007
659 \end_layout
660
661 \begin_layout Subsection*
662 LFUN_TOC_INSERT
663 \end_layout
664 \begin_layout Description
665 Action Inserts table of contents.
666 \end_layout
667 \begin_layout Description
668 Syntax toc-insert
669 \end_layout
670 \begin_layout Description
671 Origin Lgb, 27 May 97
672 \end_layout
673
674 \begin_layout Subsection*
675 LFUN_APPENDIX
676 \end_layout
677 \begin_layout Description
678 Action Start (or remove) Appendix on the given cursor position.
679 \end_layout
680 \begin_layout Description
681 Syntax appendix
682 \end_layout
683 \begin_layout Description
684 Origin ettrich, 5 May 1998
685 \end_layout
686
687 \begin_layout Subsection*
688 LFUN_INDEX_INSERT
689 \end_layout
690 \begin_layout Description
691 Action Inserts Index entry.
692 \end_layout
693 \begin_layout Description
694 Notion It automatically takes the word on the cursor position.
695 \end_layout
696 \begin_layout Description
697 Syntax index-insert [<TYPE:Name>]
698 \end_layout
699 \begin_layout Description
700 Params <TYPE:Name>: name of the index, if multiple indices are defined. with an empty argument, the default index is selected.
701 \end_layout
702 \begin_layout Description
703 Origin leeming, 3 Aug 2000
704 \end_layout
705
706 \begin_layout Subsection*
707 LFUN_INDEX_PRINT
708 \end_layout
709 \begin_layout Description
710 Action Inserts list of Index entries on a new page.
711 \end_layout
712 \begin_layout Description
713 Syntax index-print [<TYPE:Name>]
714 \end_layout
715 \begin_layout Description
716 Params <TYPE:Name>: name of the index, if multiple indices are defined. with an empty argument, the default index is selected.
717 \end_layout
718 \begin_layout Description
719 Origin Lgb, 27 Feb 1997
720 \end_layout
721
722 \begin_layout Subsection*
723 LFUN_NOMENCL_INSERT
724 \end_layout
725 \begin_layout Description
726 Action Inserts Nomenclature entry.
727 \end_layout
728 \begin_layout Description
729 Notion It automatically takes the word on the cursor position if no symbol is given.
730 \end_layout
731 \begin_layout Description
732 Syntax nomencl-insert [<SYMBOL>]
733 \end_layout
734 \begin_layout Description
735 Origin Ugras, 4 Nov 2006
736 \end_layout
737
738 \begin_layout Subsection*
739 LFUN_NOMENCLATURE_PRINT
740 \end_layout
741 \begin_layout Description
742 Action Inserts list of Nomenclature entries.
743 \end_layout
744 \begin_layout Description
745 Syntax nomenclature-print
746 \end_layout
747 \begin_layout Description
748 Origin Ugras, 4 Nov 2006
749 \end_layout
750
751 \begin_layout Subsection*
752 LFUN_NOTE_INSERT
753 \end_layout
754 \begin_layout Description
755 Action Inserts Note on the current cursor postion, move selection inside the inset.
756 \end_layout
757 \begin_layout Description
758 Syntax note-insert [<TYPE>]
759 \end_layout
760 \begin_layout Description
761 Params <TYPE>: <Note|Greyedout|Comment> default: Note
762 \end_layout
763
764 \begin_layout Subsection*
765 LFUN_NOTE_NEXT
766 \end_layout
767 \begin_layout Description
768 Action Moves the cursor to the begining of next Note inset.
769 \end_layout
770 \begin_layout Description
771 Syntax note-next
772 \end_layout
773
774 \begin_layout Subsection*
775 LFUN_NOTES_MUTATE
776 \end_layout
777 \begin_layout Description
778 Action Changes all Note insets of a particular type (source) to a different type (target) fot the current document.
779 \end_layout
780 \begin_layout Description
781 Syntax notes-mutate <SOURCE> <TARGET>
782 \end_layout
783 \begin_layout Description
784 Params <SOURCE/TARGET>: Note|Comment|Greyedout
785 \end_layout
786 \begin_layout Description
787 Origin sanda, 18 Jun 2008
788 \end_layout
789
790 \begin_layout Subsection*
791 LFUN_PHANTOM_INSERT
792 \end_layout
793 \begin_layout Description
794 Action Inserts phantom on the current cursor postion, move selection inside the inset.
795 \end_layout
796 \begin_layout Description
797 Syntax phantom-insert [<TYPE>]
798 \end_layout
799 \begin_layout Description
800 Params <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
801 \end_layout
802 \begin_layout Description
803 Origin uwestoehr, 30 Jan 2009
804 \end_layout
805
806 \begin_layout Subsection*
807 LFUN_NEWLINE_INSERT
808 \end_layout
809 \begin_layout Description
810 Action Inserts a line break or new line.
811 \end_layout
812 \begin_layout Description
813 Syntax newline-insert [<ARG>]
814 \end_layout
815 \begin_layout Description
816 Params <ARG>: <newline|linebreak> default: newline
817 \end_layout
818 \begin_layout Description
819 Origin JSpitzm, 25 Mar 2008
820 \end_layout
821
822 \begin_layout Subsection*
823 LFUN_ESCAPE
824 \end_layout
825 \begin_layout Description
826 Action Clears the selection. If no text is selected call LFUN_FINISHED_FORWARD.
827 \end_layout
828 \begin_layout Description
829 Syntax escape
830 \end_layout
831 \begin_layout Description
832 Origin Lgb, 17 May 2001
833 \end_layout
834
835 \begin_layout Subsection*
836 LFUN_DOWN
837 \end_layout
838 \begin_layout Description
839 Action Moves the cursor one line in downward direction.
840 \end_layout
841 \begin_layout Description
842 Syntax down
843 \end_layout
844
845 \begin_layout Subsection*
846 LFUN_UP
847 \end_layout
848 \begin_layout Description
849 Action Moves the cursor one line in upward direction.
850 \end_layout
851 \begin_layout Description
852 Syntax up
853 \end_layout
854
855 \begin_layout Subsection*
856 LFUN_DOWN_SELECT
857 \end_layout
858 \begin_layout Description
859 Action Moves the cursor one line in downward direction adding the current position to the selection.
860 \end_layout
861 \begin_layout Description
862 Syntax down-select
863 \end_layout
864
865 \begin_layout Subsection*
866 LFUN_UP_SELECT
867 \end_layout
868 \begin_layout Description
869 Action Moves the cursor one line in upward direction adding the current position to the selection.
870 \end_layout
871 \begin_layout Description
872 Syntax up-select
873 \end_layout
874
875 \begin_layout Subsection*
876 LFUN_SCREEN_DOWN
877 \end_layout
878 \begin_layout Description
879 Action Moves the cursor one page in downward direction.
880 \end_layout
881 \begin_layout Description
882 Syntax screen-down
883 \end_layout
884
885 \begin_layout Subsection*
886 LFUN_SCREEN_UP
887 \end_layout
888 \begin_layout Description
889 Action Moves the cursor one page in upward direction.
890 \end_layout
891 \begin_layout Description
892 Syntax screen-up
893 \end_layout
894
895 \begin_layout Subsection*
896 LFUN_SCREEN_DOWN_SELECT
897 \end_layout
898 \begin_layout Description
899 Action Moves the cursor one screen in downward direction adding the current position to the selection.
900 \end_layout
901 \begin_layout Description
902 Syntax screen-down-select
903 \end_layout
904
905 \begin_layout Subsection*
906 LFUN_SCREEN_UP_SELECT
907 \end_layout
908 \begin_layout Description
909 Action Moves the cursor one page in upward direction adding the current position to the selection.
910 \end_layout
911 \begin_layout Description
912 Syntax screen-up-select
913 \end_layout
914
915 \begin_layout Subsection*
916 LFUN_SCROLL
917 \end_layout
918 \begin_layout Description
919 Action Scroll the buffer view.
920 \end_layout
921 \begin_layout Description
922 Notion Only scrolls the screen up or down; does not move the cursor.
923 \end_layout
924 \begin_layout Description
925 Syntax scroll <TYPE> <QUANTITY>
926 \end_layout
927 \begin_layout Description
928 Params <TYPE>:  line|page
929 \begin_inset Newline newline
930 \end_inset
931
932 <QUANTITY>: up|down|<number>
933 \end_layout
934 \begin_layout Description
935 Origin Abdel, Dec 27 2007
936 \end_layout
937
938 \begin_layout Subsection*
939 LFUN_SCREEN_RECENTER
940 \end_layout
941 \begin_layout Description
942 Action Recenters the screen on the current cursor position.
943 \end_layout
944 \begin_layout Description
945 Syntax screen-recenter
946 \end_layout
947
948 \begin_layout Subsection*
949 LFUN_SCREEN_SHOW_CURSOR
950 \end_layout
951 \begin_layout Description
952 Action Repositions the screen such that the cursor is visible.
953 \end_layout
954 \begin_layout Description
955 Syntax screen-show-cursor
956 \end_layout
957 \begin_layout Description
958 Origin vfr, 25 Mar 2009
959 \end_layout
960
961 \begin_layout Subsection*
962 LFUN_CHAR_BACKWARD
963 \end_layout
964 \begin_layout Description
965 Action Moves the cursor one position logically backwards.
966 \end_layout
967 \begin_layout Description
968 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.
969 \end_layout
970 \begin_layout Description
971 Syntax char-backward
972 \end_layout
973
974 \begin_layout Subsection*
975 LFUN_CHAR_BACKWARD_SELECT
976 \end_layout
977 \begin_layout Description
978 Action Moves the cursor one position logically backwards, adding traversed position to the selection.
979 \end_layout
980 \begin_layout Description
981 Notion See also LFUN_CHAR_BACKWARD.
982 \end_layout
983 \begin_layout Description
984 Syntax char-backward-select
985 \end_layout
986
987 \begin_layout Subsection*
988 LFUN_CHAR_DELETE_BACKWARD
989 \end_layout
990 \begin_layout Description
991 Action Deletes one character in the backward direction (usually the "BackSpace" key).
992 \end_layout
993 \begin_layout Description
994 Syntax char-delete-backward
995 \end_layout
996
997 \begin_layout Subsection*
998 LFUN_CHAR_DELETE_FORWARD
999 \end_layout
1000 \begin_layout Description
1001 Action Deletes one character in the backward direction (usually the "Delete" key).
1002 \end_layout
1003 \begin_layout Description
1004 Syntax char-delete-forward
1005 \end_layout
1006
1007 \begin_layout Subsection*
1008 LFUN_CHAR_FORWARD
1009 \end_layout
1010 \begin_layout Description
1011 Action Moves the cursor one position logically forward.
1012 \end_layout
1013 \begin_layout Description
1014 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.
1015 \end_layout
1016 \begin_layout Description
1017 Syntax char-forward
1018 \end_layout
1019
1020 \begin_layout Subsection*
1021 LFUN_CHAR_FORWARD_SELECT
1022 \end_layout
1023 \begin_layout Description
1024 Action Moves the cursor one position logically forward, adding traversed position to the selection.
1025 \end_layout
1026 \begin_layout Description
1027 Notion See also LFUN_CHAR_FORWARD.
1028 \end_layout
1029 \begin_layout Description
1030 Syntax char-forward-select
1031 \end_layout
1032
1033 \begin_layout Subsection*
1034 LFUN_CHAR_LEFT
1035 \end_layout
1036 \begin_layout Description
1037 Action Moves the cursor one position "to the left".
1038 \end_layout
1039 \begin_layout Description
1040 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.
1041 \end_layout
1042 \begin_layout Description
1043 Syntax char-left
1044 \end_layout
1045
1046 \begin_layout Subsection*
1047 LFUN_CHAR_LEFT_SELECT
1048 \end_layout
1049 \begin_layout Description
1050 Action Moves the cursor one position "to the left", adding traversed position to the selection.
1051 \end_layout
1052 \begin_layout Description
1053 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1054 \end_layout
1055 \begin_layout Description
1056 Syntax char-left-select
1057 \end_layout
1058
1059 \begin_layout Subsection*
1060 LFUN_CHAR_RIGHT
1061 \end_layout
1062 \begin_layout Description
1063 Action Moves the cursor one position "to the right".
1064 \end_layout
1065 \begin_layout Description
1066 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.
1067 \end_layout
1068 \begin_layout Description
1069 Syntax char-right
1070 \end_layout
1071
1072 \begin_layout Subsection*
1073 LFUN_CHAR_RIGHT_SELECT
1074 \end_layout
1075 \begin_layout Description
1076 Action Moves the cursor one position "to the right", adding traversed position to the selection.
1077 \end_layout
1078 \begin_layout Description
1079 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1080 \end_layout
1081 \begin_layout Description
1082 Syntax char-right-select
1083 \end_layout
1084
1085 \begin_layout Subsection*
1086 LFUN_WORD_BACKWARD
1087 \end_layout
1088 \begin_layout Description
1089 Action Moves the cursor to the logically previous beginning of a word.
1090 \end_layout
1091 \begin_layout Description
1092 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.
1093 \end_layout
1094 \begin_layout Description
1095 Syntax word-backward
1096 \end_layout
1097
1098 \begin_layout Subsection*
1099 LFUN_WORD_BACKWARD_SELECT
1100 \end_layout
1101 \begin_layout Description
1102 Action Moves the cursor to the logically previous beginning of a word, adding the logically traversed text to the selection.
1103 \end_layout
1104 \begin_layout Description
1105 Notion See also LFUN_WORD_BACKWARD.
1106 \end_layout
1107 \begin_layout Description
1108 Syntax word-backward-select
1109 \end_layout
1110
1111 \begin_layout Subsection*
1112 LFUN_WORD_DELETE_BACKWARD
1113 \end_layout
1114 \begin_layout Description
1115 Action Deletes characters to the begining of the word (usually the "C+BackSpace" key).
1116 \end_layout
1117 \begin_layout Description
1118 Syntax word-delete-backward
1119 \end_layout
1120
1121 \begin_layout Subsection*
1122 LFUN_WORD_DELETE_FORWARD
1123 \end_layout
1124 \begin_layout Description
1125 Action Deletes characters to the end of the word (usually the "C+Delete" key).
1126 \end_layout
1127 \begin_layout Description
1128 Syntax word-delete-forward
1129 \end_layout
1130
1131 \begin_layout Subsection*
1132 LFUN_WORD_FIND_FORWARD
1133 \end_layout
1134 \begin_layout Description
1135 Action Search for a given string in forward direction.
1136 \end_layout
1137 \begin_layout Description
1138 Notion Case sensitive, match words. If no argument given, last search repeated.
1139 \end_layout
1140 \begin_layout Description
1141 Syntax word-find-forward [<STRING>]
1142 \end_layout
1143 \begin_layout Description
1144 Origin Etienne, 16 Feb 1998
1145 \end_layout
1146
1147 \begin_layout Subsection*
1148 LFUN_WORD_FIND_BACKWARD
1149 \end_layout
1150 \begin_layout Description
1151 Action Search for a given string in backward direction.
1152 \end_layout
1153 \begin_layout Description
1154 Notion Case sensitive, match words. If no argument given, last search repeated.
1155 \end_layout
1156 \begin_layout Description
1157 Syntax word-find-backward [<STRING>]
1158 \end_layout
1159 \begin_layout Description
1160 Origin Etienne, 20 Feb 1998
1161 \end_layout
1162
1163 \begin_layout Subsection*
1164 LFUN_WORD_FIND
1165 \end_layout
1166 \begin_layout Description
1167 Action Search for next occurence of a string.
1168 \end_layout
1169 \begin_layout Description
1170 Syntax word-find [<DATA>]
1171 \end_layout
1172 \begin_layout Description
1173 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).
1174 \end_layout
1175 \begin_layout Description
1176 Origin Andre, Jan 7 2004
1177 \end_layout
1178
1179 \begin_layout Subsection*
1180 LFUN_WORD_REPLACE
1181 \end_layout
1182 \begin_layout Description
1183 Action Replace a string in the document.
1184 \end_layout
1185 \begin_layout Description
1186 Syntax word-replace [<DATA>]
1187 \end_layout
1188 \begin_layout Description
1189 Params <DATA>: data is of the form "<search>
1190 \begin_inset Newline newline
1191 \end_inset
1192
1193 <replace>
1194 \begin_inset Newline newline
1195 \end_inset
1196
1197 <casesensitive> <matchword> <all> <forward>"
1198 \end_layout
1199 \begin_layout Description
1200 Origin Andre, Jan 7 2004
1201 \end_layout
1202
1203 \begin_layout Subsection*
1204 LFUN_WORD_FINDADV
1205 \end_layout
1206 \begin_layout Description
1207 Action Search for next occurence of a pattern.
1208 \end_layout
1209 \begin_layout Description
1210 Syntax word-findadv [<DATA>]
1211 \end_layout
1212 \begin_layout Description
1213 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).
1214 \end_layout
1215 \begin_layout Description
1216 Origin Tommaso, Nov 15 2007
1217 \end_layout
1218
1219 \begin_layout Subsection*
1220 LFUN_WORD_FORWARD
1221 \end_layout
1222 \begin_layout Description
1223 Action Moves the cursor to the logically next beginning of a word.
1224 \end_layout
1225 \begin_layout Description
1226 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.
1227 \end_layout
1228 \begin_layout Description
1229 Syntax word-forward
1230 \end_layout
1231
1232 \begin_layout Subsection*
1233 LFUN_WORD_FORWARD_SELECT
1234 \end_layout
1235 \begin_layout Description
1236 Action Moves the cursor to the logically next beginning of a word, adding the logically traversed text to the selection.
1237 \end_layout
1238 \begin_layout Description
1239 Notion See also LFUN_WORD_FORWARD.
1240 \end_layout
1241 \begin_layout Description
1242 Syntax word-forward-select
1243 \end_layout
1244
1245 \begin_layout Subsection*
1246 LFUN_WORD_LEFT
1247 \end_layout
1248 \begin_layout Description
1249 Action Moves the cursor to the next beginning of a word "on the left".
1250 \end_layout
1251 \begin_layout Description
1252 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.
1253 \end_layout
1254 \begin_layout Description
1255 Syntax word-left
1256 \end_layout
1257 \begin_layout Description
1258 Origin dov, 28 Oct 2007
1259 \end_layout
1260
1261 \begin_layout Subsection*
1262 LFUN_WORD_LEFT_SELECT
1263 \end_layout
1264 \begin_layout Description
1265 Action Moves the cursor to the next beginning of a word "on the left", adding *logically* traversed text to the selection.
1266 \end_layout
1267 \begin_layout Description
1268 Notion See also LFUN_WORD_LEFT for exact details of the movement.
1269 \end_layout
1270 \begin_layout Description
1271 Syntax word-left-select
1272 \end_layout
1273 \begin_layout Description
1274 Origin dov, 28 Oct 2007
1275 \end_layout
1276
1277 \begin_layout Subsection*
1278 LFUN_WORD_RIGHT
1279 \end_layout
1280 \begin_layout Description
1281 Action Moves the cursor to the next beginning of a word "on the right".
1282 \end_layout
1283 \begin_layout Description
1284 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.
1285 \end_layout
1286 \begin_layout Description
1287 Syntax word-right
1288 \end_layout
1289 \begin_layout Description
1290 Origin dov, 28 Oct 2007
1291 \end_layout
1292
1293 \begin_layout Subsection*
1294 LFUN_WORD_RIGHT_SELECT
1295 \end_layout
1296 \begin_layout Description
1297 Action Moves the cursor to the next beginning of a word "on the right", adding *logically* traversed text to the selection.
1298 \end_layout
1299 \begin_layout Description
1300 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
1301 \end_layout
1302 \begin_layout Description
1303 Syntax word-right-select
1304 \end_layout
1305 \begin_layout Description
1306 Origin dov, 28 Oct 2007
1307 \end_layout
1308
1309 \begin_layout Subsection*
1310 LFUN_WORD_SELECT
1311 \end_layout
1312 \begin_layout Description
1313 Action Puts the word where the cursor stands into the selection.
1314 \end_layout
1315 \begin_layout Description
1316 Syntax word-select
1317 \end_layout
1318 \begin_layout Description
1319 Origin Andre, 11 Sep 2002
1320 \end_layout
1321
1322 \begin_layout Subsection*
1323 LFUN_WORD_CAPITALIZE
1324 \end_layout
1325 \begin_layout Description
1326 Action Capitalizes the words in the selection (i.e. the first letters) or the letter on the cursor position.
1327 \end_layout
1328 \begin_layout Description
1329 Syntax word-capitalize
1330 \end_layout
1331
1332 \begin_layout Subsection*
1333 LFUN_WORD_UPCASE
1334 \end_layout
1335 \begin_layout Description
1336 Action Change the words in the selection or from the cursor position to the end of word to the upper case.
1337 \end_layout
1338 \begin_layout Description
1339 Syntax word-upcase
1340 \end_layout
1341
1342 \begin_layout Subsection*
1343 LFUN_WORD_LOWCASE
1344 \end_layout
1345 \begin_layout Description
1346 Action Change the words in the selection or from the cursor position to the end of word to the lower case.
1347 \end_layout
1348 \begin_layout Description
1349 Syntax word-lowcase
1350 \end_layout
1351
1352 \begin_layout Subsection*
1353 LFUN_THESAURUS_ENTRY
1354 \end_layout
1355 \begin_layout Description
1356 Action Look up thesaurus entries with respect to the word under the cursor.
1357 \end_layout
1358 \begin_layout Description
1359 Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
1360 \end_layout
1361 \begin_layout Description
1362 Params <STRING>: word to look up <LANG>: language (see file languages)
1363 \end_layout
1364 \begin_layout Description
1365 Origin Levon, 20 Jul 2001
1366 \end_layout
1367
1368 \begin_layout Subsection*
1369 LFUN_BUFFER_BEGIN
1370 \end_layout
1371 \begin_layout Description
1372 Action Move the cursor to the beginning of the document.
1373 \end_layout
1374 \begin_layout Description
1375 Syntax buffer-begin
1376 \end_layout
1377
1378 \begin_layout Subsection*
1379 LFUN_BUFFER_BEGIN_SELECT
1380 \end_layout
1381 \begin_layout Description
1382 Action Move the cursor to the beginning of the document adding the traversed text to the selection.
1383 \end_layout
1384 \begin_layout Description
1385 Syntax buffer-begin-select
1386 \end_layout
1387
1388 \begin_layout Subsection*
1389 LFUN_BUFFER_END
1390 \end_layout
1391 \begin_layout Description
1392 Action Move the cursor to the end of the document.
1393 \end_layout
1394 \begin_layout Description
1395 Syntax buffer-end
1396 \end_layout
1397
1398 \begin_layout Subsection*
1399 LFUN_BUFFER_END_SELECT
1400 \end_layout
1401 \begin_layout Description
1402 Action Move the cursor to the end of the document adding the traversed text to the selection.
1403 \end_layout
1404 \begin_layout Description
1405 Syntax buffer-end-select
1406 \end_layout
1407
1408 \begin_layout Subsection*
1409 LFUN_INSET_BEGIN
1410 \end_layout
1411 \begin_layout Description
1412 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
1413 \end_layout
1414 \begin_layout Description
1415 Syntax inset-begin
1416 \end_layout
1417 \begin_layout Description
1418 Origin lasgouttes, 16 Mar 2009
1419 \end_layout
1420
1421 \begin_layout Subsection*
1422 LFUN_INSET_BEGIN_SELECT
1423 \end_layout
1424 \begin_layout Description
1425 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).
1426 \end_layout
1427 \begin_layout Description
1428 Syntax inset-begin-select
1429 \end_layout
1430 \begin_layout Description
1431 Origin lasgouttes, 16 Mar 2009
1432 \end_layout
1433
1434 \begin_layout Subsection*
1435 LFUN_INSET_END
1436 \end_layout
1437 \begin_layout Description
1438 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
1439 \end_layout
1440 \begin_layout Description
1441 Syntax inset-end
1442 \end_layout
1443 \begin_layout Description
1444 Origin lasgouttes, 16 Mar 2009
1445 \end_layout
1446
1447 \begin_layout Subsection*
1448 LFUN_INSET_END_SELECT
1449 \end_layout
1450 \begin_layout Description
1451 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).
1452 \end_layout
1453 \begin_layout Description
1454 Syntax inset-end-select
1455 \end_layout
1456 \begin_layout Description
1457 Origin lasgouttes, 16 Mar 2009
1458 \end_layout
1459
1460 \begin_layout Subsection*
1461 LFUN_LINE_BEGIN
1462 \end_layout
1463 \begin_layout Description
1464 Action Move the cursor to the begining of the (screen) line.
1465 \end_layout
1466 \begin_layout Description
1467 Syntax line-begin
1468 \end_layout
1469
1470 \begin_layout Subsection*
1471 LFUN_LINE_BEGIN_SELECT
1472 \end_layout
1473 \begin_layout Description
1474 Action Move the cursor to the beginning of the (screen) line adding the traversed text to the selection.
1475 \end_layout
1476 \begin_layout Description
1477 Syntax line-begin-select
1478 \end_layout
1479
1480 \begin_layout Subsection*
1481 LFUN_LINE_END
1482 \end_layout
1483 \begin_layout Description
1484 Action Move the cursor to the end of the (screen) line.
1485 \end_layout
1486 \begin_layout Description
1487 Syntax line-end
1488 \end_layout
1489
1490 \begin_layout Subsection*
1491 LFUN_LINE_END_SELECT
1492 \end_layout
1493 \begin_layout Description
1494 Action Move the cursor to the end of the (screen) line adding the traversed text to the selection.
1495 \end_layout
1496 \begin_layout Description
1497 Syntax line-end-select
1498 \end_layout
1499
1500 \begin_layout Subsection*
1501 LFUN_LINE_DELETE
1502 \end_layout
1503 \begin_layout Description
1504 Action Deletes the letters to the end of the (screen) line or deletes the selection.
1505 \end_layout
1506 \begin_layout Description
1507 Syntax line-delete-forward
1508 \end_layout
1509
1510 \begin_layout Subsection*
1511 LFUN_COPY
1512 \end_layout
1513 \begin_layout Description
1514 Action Copies to the clipboard the last edit.
1515 \end_layout
1516 \begin_layout Description
1517 Syntax copy
1518 \end_layout
1519
1520 \begin_layout Subsection*
1521 LFUN_CUT
1522 \end_layout
1523 \begin_layout Description
1524 Action Cuts to the clipboard.
1525 \end_layout
1526 \begin_layout Description
1527 Syntax cut
1528 \end_layout
1529
1530 \begin_layout Subsection*
1531 LFUN_PASTE
1532 \end_layout
1533 \begin_layout Description
1534 Action Pastes material (text or picture) from the active clipboard.
1535 \end_layout
1536 \begin_layout Description
1537 Syntax paste [<TYPE>|<NUM>]
1538 \end_layout
1539 \begin_layout Description
1540 Params <TYPE>: emf|pdf|png|jpeg|linkback|wmf
1541 \begin_inset Newline newline
1542 \end_inset
1543
1544 <NUM>: number of the selection in the internal clipboard stack to be pasted.
1545 \end_layout
1546
1547 \begin_layout Subsection*
1548 LFUN_CLIPBOARD_PASTE
1549 \end_layout
1550 \begin_layout Description
1551 Action Pastes text from the active clipboard.
1552 \end_layout
1553 \begin_layout Description
1554 Syntax clipboard-paste [<ARG>]
1555 \end_layout
1556 \begin_layout Description
1557 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1558 \end_layout
1559 \begin_layout Description
1560 Origin baum, 10 Jul 2006
1561 \end_layout
1562
1563 \begin_layout Subsection*
1564 LFUN_PRIMARY_SELECTION_PASTE
1565 \end_layout
1566 \begin_layout Description
1567 Action Pastes the currently text selected text.
1568 \end_layout
1569 \begin_layout Description
1570 Notion Primary selection mechanism is linux-only thing.
1571 \end_layout
1572 \begin_layout Description
1573 Syntax primary-selection-paste [<ARG>]
1574 \end_layout
1575 \begin_layout Description
1576 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1577 \end_layout
1578
1579 \begin_layout Subsection*
1580 LFUN_SELECTION_PASTE
1581 \end_layout
1582 \begin_layout Description
1583 Action Pastes the text in permanent selection.
1584 \end_layout
1585 \begin_layout Description
1586 Syntax selection-paste
1587 \end_layout
1588
1589 \begin_layout Subsection*
1590 LFUN_UNDO
1591 \end_layout
1592 \begin_layout Description
1593 Action Undoes the last edit.
1594 \end_layout
1595 \begin_layout Description
1596 Syntax undo
1597 \end_layout
1598
1599 \begin_layout Subsection*
1600 LFUN_REDO
1601 \end_layout
1602 \begin_layout Description
1603 Action Redoes the last thing undone.
1604 \end_layout
1605 \begin_layout Description
1606 Syntax redo
1607 \end_layout
1608
1609 \begin_layout Subsection*
1610 LFUN_REPEAT
1611 \end_layout
1612 \begin_layout Description
1613 Action Repeat the given command.
1614 \end_layout
1615 \begin_layout Description
1616 Syntax repeat <COUNT> <LFUN-COMMAND>
1617 \end_layout
1618 \begin_layout Description
1619 Origin Andre, 27 Oct 2003
1620 \end_layout
1621
1622 \begin_layout Subsection*
1623 LFUN_CHARS_TRANSPOSE
1624 \end_layout
1625 \begin_layout Description
1626 Action Transposes the character at the cursor with the one before it.
1627 \end_layout
1628 \begin_layout Description
1629 Syntax chars-transpose
1630 \end_layout
1631 \begin_layout Description
1632 Origin Lgb, 25 Apr 2001
1633 \end_layout
1634
1635 \begin_layout Subsection*
1636 LFUN_DEPTH_DECREMENT
1637 \end_layout
1638 \begin_layout Description
1639 Action Decrease the nesting depth of the (selected) paragraph(s) inside lists.
1640 \end_layout
1641 \begin_layout Description
1642 Syntax depth-decrement
1643 \end_layout
1644
1645 \begin_layout Subsection*
1646 LFUN_DEPTH_INCREMENT
1647 \end_layout
1648 \begin_layout Description
1649 Action Increase the nesting depth of the (selected) paragraph(s) inside lists.
1650 \end_layout
1651 \begin_layout Description
1652 Syntax depth-increment
1653 \end_layout
1654
1655 \begin_layout Subsection*
1656 LFUN_FONT_BOLD
1657 \end_layout
1658 \begin_layout Description
1659 Action Toggles the bold font (selection-wise) using mathbf in math.
1660 \end_layout
1661 \begin_layout Description
1662 Syntax font-bold
1663 \end_layout
1664
1665 \begin_layout Subsection*
1666 LFUN_FONT_BOLDSYMBOL
1667 \end_layout
1668 \begin_layout Description
1669 Action Toggles the bold font (selection-wise) using boldsymbol in math.
1670 \end_layout
1671 \begin_layout Description
1672 Syntax font-boldsymbol
1673 \end_layout
1674
1675 \begin_layout Subsection*
1676 LFUN_FONT_TYPEWRITER
1677 \end_layout
1678 \begin_layout Description
1679 Action Toggles the typewriter family font (selection-wise).
1680 \end_layout
1681 \begin_layout Description
1682 Syntax font-typewriter
1683 \end_layout
1684
1685 \begin_layout Subsection*
1686 LFUN_FONT_UNDERLINE
1687 \end_layout
1688 \begin_layout Description
1689 Action Toggles underline in the font (selection-wise).
1690 \end_layout
1691 \begin_layout Description
1692 Syntax font-underline
1693 \end_layout
1694
1695 \begin_layout Subsection*
1696 LFUN_FONT_UULINE
1697 \end_layout
1698 \begin_layout Description
1699 Action Toggles double underline in the font (selection-wise).
1700 \end_layout
1701 \begin_layout Description
1702 Syntax font-underunderline
1703 \end_layout
1704 \begin_layout Description
1705 Origin sanda, 5 May 2009
1706 \end_layout
1707
1708 \begin_layout Subsection*
1709 LFUN_FONT_UWAVE
1710 \end_layout
1711 \begin_layout Description
1712 Action Toggles wavy underline in the font (selection-wise).
1713 \end_layout
1714 \begin_layout Description
1715 Syntax font-underwave
1716 \end_layout
1717 \begin_layout Description
1718 Origin sanda, 5 May 2009
1719 \end_layout
1720
1721 \begin_layout Subsection*
1722 LFUN_FONT_STRIKEOUT
1723 \end_layout
1724 \begin_layout Description
1725 Action Toggles strikeout (strike-through) in the font (selection-wise).
1726 \end_layout
1727 \begin_layout Description
1728 Syntax font-strikeout
1729 \end_layout
1730 \begin_layout Description
1731 Origin sanda, 3 May 2009
1732 \end_layout
1733
1734 \begin_layout Subsection*
1735 LFUN_FONT_EMPH
1736 \end_layout
1737 \begin_layout Description
1738 Action Toggles the emphasis font style (selection-wise).
1739 \end_layout
1740 \begin_layout Description
1741 Syntax font-emph
1742 \end_layout
1743
1744 \begin_layout Subsection*
1745 LFUN_FONT_NOUN
1746 \end_layout
1747 \begin_layout Description
1748 Action Toggles Noun text style font (selection-wise).
1749 \end_layout
1750 \begin_layout Description
1751 Syntax font-noun
1752 \end_layout
1753
1754 \begin_layout Subsection*
1755 LFUN_FONT_ROMAN
1756 \end_layout
1757 \begin_layout Description
1758 Action Toggles Roman family font (selection-wise).
1759 \end_layout
1760 \begin_layout Description
1761 Syntax font-roman
1762 \end_layout
1763
1764 \begin_layout Subsection*
1765 LFUN_FONT_SANS
1766 \end_layout
1767 \begin_layout Description
1768 Action Toggles Sans Serif family font (selection-wise).
1769 \end_layout
1770 \begin_layout Description
1771 Syntax font-sans
1772 \end_layout
1773
1774 \begin_layout Subsection*
1775 LFUN_FONT_FRAK
1776 \end_layout
1777 \begin_layout Description
1778 Action Toggles Fraktur family font (math-mode, selection-wise).
1779 \end_layout
1780 \begin_layout Description
1781 Syntax font-frak
1782 \end_layout
1783 \begin_layout Description
1784 Origin vermeer, 10 Jan 2002
1785 \end_layout
1786
1787 \begin_layout Subsection*
1788 LFUN_FONT_ITAL
1789 \end_layout
1790 \begin_layout Description
1791 Action Toggles Italics font shape (math-mode, selection-wise).
1792 \end_layout
1793 \begin_layout Description
1794 Syntax font-ital
1795 \end_layout
1796 \begin_layout Description
1797 Origin vermeer, 10 Jan 2002
1798 \end_layout
1799
1800 \begin_layout Subsection*
1801 LFUN_FONT_DEFAULT
1802 \end_layout
1803 \begin_layout Description
1804 Action Reverts the settings of the font to the default values (selection-wise).
1805 \end_layout
1806 \begin_layout Description
1807 Syntax font-default
1808 \end_layout
1809
1810 \begin_layout Subsection*
1811 LFUN_FONT_SIZE
1812 \end_layout
1813 \begin_layout Description
1814 Action Sets font size according to lyx format string.
1815 \end_layout
1816 \begin_layout Description
1817 Syntax font-size <SIZE>
1818 \end_layout
1819 \begin_layout Description
1820 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
1821 \begin_inset Newline newline
1822 \end_inset
1823
1824 largest|huge|giant|increase|decrease|default
1825 \end_layout
1826
1827 \begin_layout Subsection*
1828 LFUN_TEXTSTYLE_APPLY
1829 \end_layout
1830 \begin_layout Description
1831 Action Toggle user-defined (=last-time used) text style.
1832 \end_layout
1833 \begin_layout Description
1834 Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically trigerred when using Text Style dialog.
1835 \end_layout
1836 \begin_layout Description
1837 Syntax textstyle-apply
1838 \end_layout
1839 \begin_layout Description
1840 Origin leeming, 12 Mar 2003
1841 \end_layout
1842
1843 \begin_layout Subsection*
1844 LFUN_TEXTSTYLE_UPDATE
1845 \end_layout
1846 \begin_layout Description
1847 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APPLY.
1848 \end_layout
1849 \begin_layout Description
1850 Syntax textstyle-update <FONT_INFO>
1851 \end_layout
1852 \begin_layout Description
1853 Params <FONT_INFO>: specifies font atributes, e.g. family, series, shape, size, emph, noun, underbar, number, color, language, toggleall.
1854 \begin_inset Newline newline
1855 \end_inset
1856
1857 Use lyx -dbg action for exact syntax of text-style dialog parameters.
1858 \end_layout
1859 \begin_layout Description
1860 Origin leeming, 12 Mar 2003
1861 \end_layout
1862
1863 \begin_layout Subsection*
1864 LFUN_SCREEN_FONT_UPDATE
1865 \end_layout
1866 \begin_layout Description
1867 Action Update fonts and its metrics.
1868 \end_layout
1869 \begin_layout Description
1870 Notion Automatically called after zoom, dpi, font names, or norm change.
1871 \end_layout
1872 \begin_layout Description
1873 Syntax screen-font-update
1874 \end_layout
1875 \begin_layout Description
1876 Origin ARRae, 13 Aug 2000
1877 \end_layout
1878
1879 \begin_layout Subsection*
1880 LFUN_FONT_STATE
1881 \end_layout
1882 \begin_layout Description
1883 Action Returns the info about the current font.
1884 \end_layout
1885 \begin_layout Description
1886 Syntax font-state
1887 \end_layout
1888
1889 \begin_layout Subsection*
1890 LFUN_CITATION_INSERT
1891 \end_layout
1892 \begin_layout Description
1893 Action Inserts citation from loaded citation database.
1894 \end_layout
1895 \begin_layout Description
1896 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
1897 \end_layout
1898 \begin_layout Description
1899 Params <KEY>: Citation (shortcut listed in available citations).
1900 \begin_inset Newline newline
1901 \end_inset
1902
1903 <TEXT_BEFORE>: text which should appear before citation.
1904 \end_layout
1905 \begin_layout Description
1906 Origin AAS, 97-02-23
1907 \end_layout
1908
1909 \begin_layout Subsection*
1910 LFUN_BIBTEX_DATABASE_ADD
1911 \end_layout
1912 \begin_layout Description
1913 Action Adds database, which will be used for bibtex citations.
1914 \end_layout
1915 \begin_layout Description
1916 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1917 \end_layout
1918 \begin_layout Description
1919 Syntax bibtex-database-add <DATABASE-NAME>
1920 \end_layout
1921 \begin_layout Description
1922 Origin Ale, 30 May 1997
1923 \end_layout
1924
1925 \begin_layout Subsection*
1926 LFUN_BIBTEX_DATABASE_DEL
1927 \end_layout
1928 \begin_layout Description
1929 Action Adds database, which will be used for bibtex citations.
1930 \end_layout
1931 \begin_layout Description
1932 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1933 \end_layout
1934 \begin_layout Description
1935 Syntax bibtex-database-del <DATABASE-NAME>
1936 \end_layout
1937 \begin_layout Description
1938 Origin Ale, 30 May 1997
1939 \end_layout
1940
1941 \begin_layout Subsection*
1942 LFUN_LAYOUT
1943 \end_layout
1944 \begin_layout Description
1945 Action Sets the layout (that is, environment) for the current paragraph.
1946 \end_layout
1947 \begin_layout Description
1948 Syntax layout <LAYOUT>
1949 \end_layout
1950 \begin_layout Description
1951 Params <LAYOUT>: the layout to use
1952 \end_layout
1953
1954 \begin_layout Subsection*
1955 LFUN_LAYOUT_PARAGRAPH
1956 \end_layout
1957 \begin_layout Description
1958 Action Launches the paragraph settings dialog.
1959 \end_layout
1960 \begin_layout Description
1961 Syntax layout-paragraph
1962 \end_layout
1963
1964 \begin_layout Subsection*
1965 LFUN_LAYOUT_TABULAR
1966 \end_layout
1967 \begin_layout Description
1968 Action Launches the tabular settings dialog.
1969 \end_layout
1970 \begin_layout Description
1971 Syntax layout-tabular
1972 \end_layout
1973 \begin_layout Description
1974 Origin Jug, 31 Jul 2000
1975 \end_layout
1976
1977 \begin_layout Subsection*
1978 LFUN_DROP_LAYOUTS_CHOICE
1979 \end_layout
1980 \begin_layout Description
1981 Action Displays list of layout choices.
1982 \end_layout
1983 \begin_layout Description
1984 Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox allowing for choice of layout.
1985 \end_layout
1986 \begin_layout Description
1987 Syntax drop-layouts-choice
1988 \end_layout
1989
1990 \begin_layout Subsection*
1991 LFUN_LAYOUT_MODULES_CLEAR
1992 \end_layout
1993 \begin_layout Description
1994 Action Clears the module list.
1995 \end_layout
1996 \begin_layout Description
1997 Notion Clears the list of included modules for the current buffer.
1998 \end_layout
1999 \begin_layout Description
2000 Syntax layout-modules-clear
2001 \end_layout
2002 \begin_layout Description
2003 Origin rgh, 25 August 2007
2004 \end_layout
2005
2006 \begin_layout Subsection*
2007 LFUN_LAYOUT_MODULE_ADD
2008 \end_layout
2009 \begin_layout Description
2010 Action Adds a module.
2011 \end_layout
2012 \begin_layout Description
2013 Notion Adds a module to the list of included modules for the current buffer.
2014 \end_layout
2015 \begin_layout Description
2016 Syntax layout-module-add <MODULE>
2017 \end_layout
2018 \begin_layout Description
2019 Params <MODULE>: the module to be added
2020 \end_layout
2021 \begin_layout Description
2022 Origin rgh, 25 August 2007
2023 \end_layout
2024
2025 \begin_layout Subsection*
2026 LFUN_LAYOUT_RELOAD
2027 \end_layout
2028 \begin_layout Description
2029 Action Reloads layout information.
2030 \end_layout
2031 \begin_layout Description
2032 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.
2033 \end_layout
2034 \begin_layout Description
2035 Syntax layout-reload
2036 \end_layout
2037 \begin_layout Description
2038 Origin rgh, 3 September 2007
2039 \end_layout
2040
2041 \begin_layout Subsection*
2042 LFUN_TEXTCLASS_APPLY
2043 \end_layout
2044 \begin_layout Description
2045 Action Sets the text class for the current buffer.
2046 \end_layout
2047 \begin_layout Description
2048 Syntax textclass-apply <TEXTCLASS>
2049 \end_layout
2050 \begin_layout Description
2051 Params <TEXTCLASS>: the textclass to set. Note that this must be the filename, minus the ".layout" extension.
2052 \end_layout
2053
2054 \begin_layout Subsection*
2055 LFUN_TEXTCLASS_LOAD
2056 \end_layout
2057 \begin_layout Description
2058 Action Loads information for a textclass from disk.
2059 \end_layout
2060 \begin_layout Description
2061 Syntax textclass-load <TEXTCLASS>
2062 \end_layout
2063 \begin_layout Description
2064 Params <TEXTCLASS>: the textclass to load. Note that this must be the filename, minus the ".layout" extension.
2065 \end_layout
2066
2067 \begin_layout Subsection*
2068 LFUN_MARK_OFF
2069 \end_layout
2070 \begin_layout Description
2071 Action Disable selecting of text-region.
2072 \end_layout
2073 \begin_layout Description
2074 Syntax mark-off
2075 \end_layout
2076
2077 \begin_layout Subsection*
2078 LFUN_MARK_ON
2079 \end_layout
2080 \begin_layout Description
2081 Action Enable selecting of text-region.
2082 \end_layout
2083 \begin_layout Description
2084 Notion After enabling you can simply move arrow keys to get selected region.
2085 \end_layout
2086 \begin_layout Description
2087 Syntax mark-on
2088 \end_layout
2089
2090 \begin_layout Subsection*
2091 LFUN_MARK_TOGGLE
2092 \end_layout
2093 \begin_layout Description
2094 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
2095 \end_layout
2096 \begin_layout Description
2097 Syntax mark-toggle
2098 \end_layout
2099 \begin_layout Description
2100 Origin Andre, May 5 2006
2101 \end_layout
2102
2103 \begin_layout Subsection*
2104 LFUN_MATH_DELIM
2105 \end_layout
2106 \begin_layout Description
2107 Action Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
2108 \end_layout
2109 \begin_layout Description
2110 Syntax math-delim [<LEFT>] [<RIGHT>]
2111 \end_layout
2112 \begin_layout Description
2113 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.
2114 \end_layout
2115 \begin_layout Description
2116 Sample math-delim { rangle
2117 \end_layout
2118 \begin_layout Description
2119 Origin Alejandro, 18 Jun 1996
2120 \end_layout
2121
2122 \begin_layout Subsection*
2123 LFUN_MATH_BIGDELIM
2124 \end_layout
2125 \begin_layout Description
2126 Action Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
2127 \end_layout
2128 \begin_layout Description
2129 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
2130 \end_layout
2131 \begin_layout Description
2132 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
2133 \begin_inset Newline newline
2134 \end_inset
2135
2136 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
2137 \end_layout
2138 \begin_layout Description
2139 Sample math-bigdelim "Bigl" "
2140 \backslash
2141 Downarrow" "Bigr" "
2142 \backslash
2143 }"
2144 \end_layout
2145 \begin_layout Description
2146 Origin Enrico & Georg, 7 May 2006
2147 \end_layout
2148
2149 \begin_layout Subsection*
2150 LFUN_MATH_DISPLAY
2151 \end_layout
2152 \begin_layout Description
2153 Action Creates a new displayed equation in text mode. Toggles inlined/display formula in math mode.
2154 \end_layout
2155 \begin_layout Description
2156 Syntax math-display [<ARG>]
2157 \end_layout
2158 \begin_layout Description
2159 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating new equation from the text mode.
2160 \end_layout
2161 \begin_layout Description
2162 Origin Alejandro, 18 Jun 1996
2163 \end_layout
2164
2165 \begin_layout Subsection*
2166 LFUN_MATH_INSERT
2167 \end_layout
2168 \begin_layout Description
2169 Action Inserts math objects and symbols.
2170 \end_layout
2171 \begin_layout Description
2172 Syntax math-insert <ARG>
2173 \end_layout
2174 \begin_layout Description
2175 Params <ARG>: Symbol or LaTeX code to be inserted.
2176 \end_layout
2177
2178 \begin_layout Subsection*
2179 LFUN_MATH_SUBSCRIPT
2180 \end_layout
2181 \begin_layout Description
2182 Action Enters subscript expression in math expression.
2183 \end_layout
2184 \begin_layout Description
2185 Syntax math-subscript
2186 \end_layout
2187 \begin_layout Description
2188 Origin vermeer, 12 Dec 2001
2189 \end_layout
2190
2191 \begin_layout Subsection*
2192 LFUN_MATH_SUPERSCRIPT
2193 \end_layout
2194 \begin_layout Description
2195 Action Enters subscript expression in math expression.
2196 \end_layout
2197 \begin_layout Description
2198 Syntax math-superscript
2199 \end_layout
2200 \begin_layout Description
2201 Origin vermeer, 12 Dec 2001
2202 \end_layout
2203
2204 \begin_layout Subsection*
2205 LFUN_MATH_LIMITS
2206 \end_layout
2207 \begin_layout Description
2208 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.
2209 \end_layout
2210 \begin_layout Description
2211 Notion Put the cursor before the symbol with the limits and then invoke math-limits.
2212 \end_layout
2213 \begin_layout Description
2214 Syntax math-limits [<STATE>]
2215 \end_layout
2216 \begin_layout Description
2217 Params <STATE>: limits|nolimits
2218 \end_layout
2219
2220 \begin_layout Subsection*
2221 LFUN_MATH_MACRO
2222 \end_layout
2223 \begin_layout Description
2224 Action Inserts a math macro definition at the cursor position in the text.
2225 \end_layout
2226 \begin_layout Description
2227 Syntax math-macro <NAME> [<NARGS>] [def]
2228 \end_layout
2229 \begin_layout Description
2230 Params <NAME>: The name of the macro, e.g. "mymacro".
2231 \begin_inset Newline newline
2232 \end_inset
2233
2234 <NARGS>: The number of parameters of the macro. Default is 0. "def": Has no effect anymore, just for compatibility with former LyX versions.
2235 \end_layout
2236 \begin_layout Description
2237 Origin ale, 10 May 1997;  sts, 21 Dec 2007
2238 \end_layout
2239
2240 \begin_layout Subsection*
2241 LFUN_MATH_MUTATE
2242 \end_layout
2243 \begin_layout Description
2244 Action Mutates the type of math inset to the newly selected one.
2245 \end_layout
2246 \begin_layout Description
2247 Syntax math-mutate <TYPE>
2248 \end_layout
2249 \begin_layout Description
2250 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat| multline|gather|flalign
2251 \end_layout
2252 \begin_layout Description
2253 Origin Andre, 23 May 2001
2254 \end_layout
2255
2256 \begin_layout Subsection*
2257 LFUN_MATH_SPACE
2258 \end_layout
2259 \begin_layout Description
2260 Action Inserts space into math expression.
2261 \end_layout
2262 \begin_layout Description
2263 Notion Use spacebar after entering this space to change type of space.
2264 \end_layout
2265 \begin_layout Description
2266 Syntax math-space [<TYPE>] [<LEN>]
2267 \end_layout
2268 \begin_layout Description
2269 Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
2270 \begin_inset Newline newline
2271 \end_inset
2272
2273 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
2274 \begin_inset Newline newline
2275 \end_inset
2276
2277 custom space: hspace
2278 \begin_inset Newline newline
2279 \end_inset
2280
2281 "," used by default.
2282 \begin_inset Newline newline
2283 \end_inset
2284
2285 Note that ! is equivalent to negthinspace, , = thinspace, : = medspace, and ; = thickspace.
2286 \begin_inset Newline newline
2287 \end_inset
2288
2289 <LEN>: length for custom spaces (hspace)
2290 \end_layout
2291 \begin_layout Description
2292 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
2293 \end_layout
2294
2295 \begin_layout Subsection*
2296 LFUN_MATH_MATRIX
2297 \end_layout
2298 \begin_layout Description
2299 Action Inserts a matrix.
2300 \end_layout
2301 \begin_layout Description
2302 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
2303 \end_layout
2304 \begin_layout Description
2305 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).
2306 \end_layout
2307 \begin_layout Description
2308 Sample math-matrix 3 3 bccc
2309 \end_layout
2310
2311 \begin_layout Subsection*
2312 LFUN_MATH_MODE
2313 \end_layout
2314 \begin_layout Description
2315 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.
2316 \end_layout
2317 \begin_layout Description
2318 Notion If there is some selected text, it puts the text inside created math box.
2319 \end_layout
2320 \begin_layout Description
2321 Syntax math-mode [on|<ARG>]
2322 \end_layout
2323 \begin_layout Description
2324 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT .
2325 \begin_inset Newline newline
2326 \end_inset
2327
2328 "on": allow only entering of math mode from text mode.
2329 \end_layout
2330 \begin_layout Description
2331 Origin Alejandro, 4 Jun 1996
2332 \end_layout
2333
2334 \begin_layout Subsection*
2335 LFUN_REGEXP_MODE
2336 \end_layout
2337 \begin_layout Description
2338 Action Enters regexp mode (i.e., puts regexp insets on the current cursor position). Used by the advanced search dialog.
2339 \end_layout
2340 \begin_layout Description
2341 Notion If there is any selected text, then it is moved inside the created regexp inset.
2342 \end_layout
2343 \begin_layout Description
2344 Syntax regexp-mode [<ARG>]
2345 \end_layout
2346 \begin_layout Description
2347 Params <ARG>: eventual argument (regular expression).
2348 \end_layout
2349 \begin_layout Description
2350 Origin Tommaso, 4 Oct 2008
2351 \end_layout
2352
2353 \begin_layout Subsection*
2354 LFUN_MATH_NUMBER_LINE_TOGGLE
2355 \end_layout
2356 \begin_layout Description
2357 Action Toggles numbering of the current formula line.
2358 \end_layout
2359 \begin_layout Description
2360 Notion Must be in display formula mode.
2361 \end_layout
2362 \begin_layout Description
2363 Syntax math-number-line-toggle
2364 \end_layout
2365 \begin_layout Description
2366 Origin Alejandro, 18 Jun 1996
2367 \end_layout
2368
2369 \begin_layout Subsection*
2370 LFUN_MATH_NUMBER_TOGGLE
2371 \end_layout
2372 \begin_layout Description
2373 Action Toggles numbering/labeling of the current formula.
2374 \end_layout
2375 \begin_layout Description
2376 Notion Must be in display formula mode.
2377 \end_layout
2378 \begin_layout Description
2379 Syntax math-number-toggle
2380 \end_layout
2381 \begin_layout Description
2382 Origin Alejandro, 4 Jun 1996
2383 \end_layout
2384
2385 \begin_layout Subsection*
2386 LFUN_MATH_EXTERN
2387 \end_layout
2388 \begin_layout Description
2389 Action Calls external program and passes the current expression/equation as an argument for the calculation in the format appropriate to the given language.
2390 \end_layout
2391 \begin_layout Description
2392 Notion Selection can be used to determine the input for the external program.
2393 \end_layout
2394 \begin_layout Description
2395 Syntax math-extern <LANG> [<COMMAND>]
2396 \end_layout
2397 \begin_layout Description
2398 Params <LANG>: octave|maxima|maple|mathematica|script
2399 \begin_inset Newline newline
2400 \end_inset
2401
2402 where "script" stands fot the external script (normalized expression will be passed)
2403 \end_layout
2404 \begin_layout Description
2405 Sample math-extern maple simplify
2406 \end_layout
2407 \begin_layout Description
2408 Origin Andre, 24 Apr 2001
2409 \end_layout
2410
2411 \begin_layout Subsection*
2412 LFUN_MATH_SIZE
2413 \end_layout
2414 \begin_layout Description
2415 Action Changes arbitrarily the size used by math fonts inside a context.
2416 \end_layout
2417 \begin_layout Description
2418 Notion Provides an interface to the LaTeX math mode font size commands.
2419 \end_layout
2420 \begin_layout Description
2421 Syntax math-size <STYLE>
2422 \end_layout
2423 \begin_layout Description
2424 Params <STYLE>: 
2425 \backslash
2426 displaystyle|
2427 \backslash
2428 textstyle|
2429 \backslash
2430 scriptstyle|
2431 \backslash
2432 scriptscriptstyle
2433 \end_layout
2434 \begin_layout Description
2435 Origin Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
2436 \end_layout
2437
2438 \begin_layout Subsection*
2439 LFUN_MATH_FONT_STYLE
2440 \end_layout
2441 \begin_layout Description
2442 Action Changes the text style used in math.
2443 \end_layout
2444 \begin_layout Description
2445 Syntax math-font-style <STYLE>
2446 \end_layout
2447 \begin_layout Description
2448 Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf |textnormal|textrm|textsf|texttt|textbf|textmd|textit |textsc|textsl|textup
2449 \end_layout
2450 \begin_layout Description
2451 Origin vfr, 9 jan 2009
2452 \end_layout
2453
2454 \begin_layout Subsection*
2455 LFUN_MATH_MACRO_UNFOLD
2456 \end_layout
2457 \begin_layout Description
2458 Action Unfold a Math Macro.
2459 \end_layout
2460 \begin_layout Description
2461 Notion Unfold the Math Macro the cursor is in, i.e. display it as 
2462 \backslash
2463 foo.
2464 \end_layout
2465 \begin_layout Description
2466 Syntax math-macro-unfold
2467 \end_layout
2468 \begin_layout Description
2469 Origin sts, 06 January 2008
2470 \end_layout
2471
2472 \begin_layout Subsection*
2473 LFUN_MATH_MACRO_FOLD
2474 \end_layout
2475 \begin_layout Description
2476 Action Fold a Math Macro.
2477 \end_layout
2478 \begin_layout Description
2479 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e. displayed as 
2480 \backslash
2481 foo before.
2482 \end_layout
2483 \begin_layout Description
2484 Syntax math-macro-fold
2485 \end_layout
2486 \begin_layout Description
2487 Origin sts, 06 January 2008
2488 \end_layout
2489
2490 \begin_layout Subsection*
2491 LFUN_MATH_MACRO_ADD_PARAM
2492 \end_layout
2493 \begin_layout Description
2494 Action Add a parameter.
2495 \end_layout
2496 \begin_layout Description
2497 Notion Add a parameter to a Math Macro.
2498 \end_layout
2499 \begin_layout Description
2500 Syntax math-macro-add-param <NUM>
2501 \end_layout
2502 \begin_layout Description
2503 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.
2504 \end_layout
2505 \begin_layout Description
2506 Origin sts, 06 January 2008
2507 \end_layout
2508
2509 \begin_layout Subsection*
2510 LFUN_MATH_MACRO_REMOVE_PARAM
2511 \end_layout
2512 \begin_layout Description
2513 Action Remove the last parameter.
2514 \end_layout
2515 \begin_layout Description
2516 Notion Remove the last parameter of a Math Macro and remove its value in all instances of the macro in the buffer.
2517 \end_layout
2518 \begin_layout Description
2519 Syntax math-macro-remove-param <NUM>
2520 \end_layout
2521 \begin_layout Description
2522 Params <NUM>: The number of the parameter to be deleted (1 for the first), defaults to the last one.
2523 \end_layout
2524 \begin_layout Description
2525 Origin sts, 06 January 2008
2526 \end_layout
2527
2528 \begin_layout Subsection*
2529 LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
2530 \end_layout
2531 \begin_layout Description
2532 Action Append a greedy parameter.
2533 \end_layout
2534 \begin_layout Description
2535 Notion Append a greedy parameter to a Math Macro which eats the following mathed cell in every instance of the macro in the buffer.
2536 \end_layout
2537 \begin_layout Description
2538 Syntax math-macro-append-greedy-param
2539 \end_layout
2540 \begin_layout Description
2541 Origin sts, 06 January 2008
2542 \end_layout
2543
2544 \begin_layout Subsection*
2545 LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
2546 \end_layout
2547 \begin_layout Description
2548 Action Remove a greedy parameter.
2549 \end_layout
2550 \begin_layout Description
2551 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.
2552 \end_layout
2553 \begin_layout Description
2554 Syntax math-macro-remove-greedy-param
2555 \end_layout
2556 \begin_layout Description
2557 Origin sts, 06 January 2008
2558 \end_layout
2559
2560 \begin_layout Subsection*
2561 LFUN_MATH_MACRO_MAKE_OPTIONAL
2562 \end_layout
2563 \begin_layout Description
2564 Action Make a parameter optional.
2565 \end_layout
2566 \begin_layout Description
2567 Notion Turn the first non-optional parameter of a Math Macro into an optional parameter with a default value.
2568 \end_layout
2569 \begin_layout Description
2570 Syntax math-macro-make-optional
2571 \end_layout
2572 \begin_layout Description
2573 Origin sts, 06 January 2008
2574 \end_layout
2575
2576 \begin_layout Subsection*
2577 LFUN_MATH_MACRO_MAKE_NONOPTIONAL
2578 \end_layout
2579 \begin_layout Description
2580 Action Make a parameter non-optional.
2581 \end_layout
2582 \begin_layout Description
2583 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.
2584 \end_layout
2585 \begin_layout Description
2586 Syntax math-macro-make-nonoptional
2587 \end_layout
2588 \begin_layout Description
2589 Origin sts, 06 January 2008
2590 \end_layout
2591
2592 \begin_layout Subsection*
2593 LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
2594 \end_layout
2595 \begin_layout Description
2596 Action Add an optional parameter.
2597 \end_layout
2598 \begin_layout Description
2599 Notion Insert an optional parameter just behind the already existing optional parameters.
2600 \end_layout
2601 \begin_layout Description
2602 Syntax math-macro-add-optional-param
2603 \end_layout
2604 \begin_layout Description
2605 Origin sts, 06 January 2008
2606 \end_layout
2607
2608 \begin_layout Subsection*
2609 LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
2610 \end_layout
2611 \begin_layout Description
2612 Action Remove the last optional parameter.
2613 \end_layout
2614 \begin_layout Description
2615 Notion Remove the last optional parameter of a Math Macro and remove it in all the instances of the macro in the buffer.
2616 \end_layout
2617 \begin_layout Description
2618 Syntax math-macro-remove-optional-param
2619 \end_layout
2620 \begin_layout Description
2621 Origin sts, 06 January 2008
2622 \end_layout
2623
2624 \begin_layout Subsection*
2625 LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
2626 \end_layout
2627 \begin_layout Description
2628 Action Add a greedy optional parameter.
2629 \end_layout
2630 \begin_layout Description
2631 Notion Add a greedy optional parameter which eats the value from the following cells in mathed which are in the [value] format.
2632 \end_layout
2633 \begin_layout Description
2634 Syntax math-macro-add-greedy-optional-param
2635 \end_layout
2636 \begin_layout Description
2637 Origin sts, 06 January 2008
2638 \end_layout
2639
2640 \begin_layout Subsection*
2641 LFUN_IN_MATHMACROTEMPLATE
2642 \end_layout
2643 \begin_layout Description
2644 Action Only active in Math Macro definition.
2645 \end_layout
2646 \begin_layout Description
2647 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.
2648 \end_layout
2649 \begin_layout Description
2650 Syntax in-mathmacrotemplate
2651 \end_layout
2652 \begin_layout Description
2653 Origin sts, 06 January 2008
2654 \end_layout
2655
2656 \begin_layout Subsection*
2657 LFUN_PARAGRAPH_MOVE_DOWN
2658 \end_layout
2659 \begin_layout Description
2660 Action Moves the current paragraph downwards in the document.
2661 \end_layout
2662 \begin_layout Description
2663 Syntax paragraph-move-down
2664 \end_layout
2665 \begin_layout Description
2666 Origin Edwin, 8 Apr 2006
2667 \end_layout
2668
2669 \begin_layout Subsection*
2670 LFUN_PARAGRAPH_MOVE_UP
2671 \end_layout
2672 \begin_layout Description
2673 Action Moves the current paragraph upwards in the document.
2674 \end_layout
2675 \begin_layout Description
2676 Syntax paragraph-move-up
2677 \end_layout
2678 \begin_layout Description
2679 Origin Edwin, 8 Apr 2006
2680 \end_layout
2681
2682 \begin_layout Subsection*
2683 LFUN_PARAGRAPH_UP
2684 \end_layout
2685 \begin_layout Description
2686 Action Move the cursor to the next paragraph (or begining of the current one) in upward direction.
2687 \end_layout
2688 \begin_layout Description
2689 Syntax paragraph-up
2690 \end_layout
2691 \begin_layout Description
2692 Origin Asger, 1 Oct 1996
2693 \end_layout
2694
2695 \begin_layout Subsection*
2696 LFUN_PARAGRAPH_UP_SELECT
2697 \end_layout
2698 \begin_layout Description
2699 Action Move the cursor and select the text to the next paragraph (or begining of the current one) in upward direction.
2700 \end_layout
2701 \begin_layout Description
2702 Syntax paragraph-up-select
2703 \end_layout
2704 \begin_layout Description
2705 Origin Asger, 1 Oct 1996
2706 \end_layout
2707
2708 \begin_layout Subsection*
2709 LFUN_PARAGRAPH_DOWN
2710 \end_layout
2711 \begin_layout Description
2712 Action Move the cursor to the next paragraph (or begining of the current one) in downward direction.
2713 \end_layout
2714 \begin_layout Description
2715 Syntax paragraph-down
2716 \end_layout
2717 \begin_layout Description
2718 Origin Asger, 1 Oct 1996
2719 \end_layout
2720
2721 \begin_layout Subsection*
2722 LFUN_PARAGRAPH_DOWN_SELECT
2723 \end_layout
2724 \begin_layout Description
2725 Action Move the cursor and select the text to the next paragraph (or begining of the current one) in downward direction.
2726 \end_layout
2727 \begin_layout Description
2728 Syntax paragraph-down-select
2729 \end_layout
2730 \begin_layout Description
2731 Origin Asger, 1 Oct 1996
2732 \end_layout
2733
2734 \begin_layout Subsection*
2735 LFUN_PARAGRAPH_GOTO
2736 \end_layout
2737 \begin_layout Description
2738 Action Jump to a paragraph given by its id number and optionally the desired position within the paragraph.
2739 \end_layout
2740 \begin_layout Description
2741 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).
2742 \end_layout
2743 \begin_layout Description
2744 Syntax paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
2745 \end_layout
2746 \begin_layout Description
2747 Params <PAR_ID_NUMBER>:  paragraph id
2748 \begin_inset Newline newline
2749 \end_inset
2750
2751 <POSITION_IN_PAR>: desired position within the paragraph
2752 \end_layout
2753 \begin_layout Description
2754 Origin Dekel, 26 Aug 2000
2755 \end_layout
2756
2757 \begin_layout Subsection*
2758 LFUN_BREAK_PARAGRAPH
2759 \end_layout
2760 \begin_layout Description
2761 Action Breaks the current paragraph at the current location.
2762 \end_layout
2763 \begin_layout Description
2764 Syntax break-paragraph
2765 \end_layout
2766
2767 \begin_layout Subsection*
2768 LFUN_BREAK_PARAGRAPH
2769 \end_layout
2770 \begin_layout Description
2771 Action Breaks the current paragraph at the current location.
2772 \end_layout
2773 \begin_layout Description
2774 Notion Removes the selection.
2775 \end_layout
2776 \begin_layout Description
2777 Syntax break-paragraph [<LAYOUT>]
2778 \end_layout
2779 \begin_layout Description
2780 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to default layout) when the cursor is at the end of the line.
2781 \end_layout
2782
2783 \begin_layout Subsection*
2784 LFUN_PARAGRAPH_PARAMS
2785 \end_layout
2786 \begin_layout Description
2787 Action Change paragraph settings.
2788 \end_layout
2789 \begin_layout Description
2790 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.
2791 \end_layout
2792 \begin_layout Description
2793 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
2794 \end_layout
2795 \begin_layout Description
2796 Params <INDENT>:  
2797 \backslash
2798 noindent|
2799 \backslash
2800 indent|
2801 \backslash
2802 indent-toggle|
2803 \backslash
2804 leftindent LENGTH
2805 \begin_inset Newline newline
2806 \end_inset
2807
2808 <SPACING>: 
2809 \backslash
2810 paragraph_spacing default|single|onehalf|double|other
2811 \begin_inset Newline newline
2812 \end_inset
2813
2814 <ALIGN>:   
2815 \backslash
2816 align block|left|right|center|default
2817 \begin_inset Newline newline
2818 \end_inset
2819
2820 <OTHERS>:  
2821 \backslash
2822 labelwidthstring WIDTH|
2823 \backslash
2824 start_of_appendix
2825 \end_layout
2826 \begin_layout Description
2827 Origin rgh, Aug 15 2007
2828 \end_layout
2829
2830 \begin_layout Subsection*
2831 LFUN_PARAGRAPH_PARAMS_APPLY
2832 \end_layout
2833 \begin_layout Description
2834 Action Change paragraph settings.
2835 \end_layout
2836 \begin_layout Description
2837 Notion Overwrite all nonspecified settings to the default ones. Use paragraph-params lfun if you don't want to overwrite others settings.
2838 \end_layout
2839 \begin_layout Description
2840 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
2841 \end_layout
2842 \begin_layout Description
2843 Params For parameters see LFUN_PARAGRAPH_PARAMS
2844 \end_layout
2845 \begin_layout Description
2846 Origin leeming, 30 Mar 2004
2847 \end_layout
2848
2849 \begin_layout Subsection*
2850 LFUN_PARAGRAPH_UPDATE
2851 \end_layout
2852 \begin_layout Description
2853 Action Updates the values inside the paragraph dialog from the paragraph.
2854 \end_layout
2855 \begin_layout Description
2856 Notion This is internal LFUN, not to be used by users. Called internally by LFUN_DIALOG_UPDATE.
2857 \end_layout
2858 \begin_layout Description
2859 Origin leeming, 13 Mar 2003
2860 \end_layout
2861
2862 \begin_layout Subsection*
2863 LFUN_OUTLINE_UP
2864 \end_layout
2865 \begin_layout Description
2866 Action Move the current group in the upward direction in the structure of the document.
2867 \end_layout
2868 \begin_layout Description
2869 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
2870 \end_layout
2871 \begin_layout Description
2872 Syntax outline-up
2873 \end_layout
2874 \begin_layout Description
2875 Origin Vermeer, 23 Mar 2006
2876 \end_layout
2877
2878 \begin_layout Subsection*
2879 LFUN_OUTLINE_DOWN
2880 \end_layout
2881 \begin_layout Description
2882 Action Move the current group in the downward direction in the structure of the document.
2883 \end_layout
2884 \begin_layout Description
2885 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
2886 \end_layout
2887 \begin_layout Description
2888 Syntax outline-down
2889 \end_layout
2890 \begin_layout Description
2891 Origin Vermeer, 23 Mar 2006
2892 \end_layout
2893
2894 \begin_layout Subsection*
2895 LFUN_OUTLINE_IN
2896 \end_layout
2897 \begin_layout Description
2898 Action Moves the current group in the downward direction in the hierarchy of the document structure.
2899 \end_layout
2900 \begin_layout Description
2901 Notion Part -> Chapter -> Section -> etc.
2902 \end_layout
2903 \begin_layout Description
2904 Syntax outline-in
2905 \end_layout
2906 \begin_layout Description
2907 Origin Vermeer, 23 Mar 2006
2908 \end_layout
2909
2910 \begin_layout Subsection*
2911 LFUN_OUTLINE_OUT
2912 \end_layout
2913 \begin_layout Description
2914 Action Moves the current group in the upward direction in the hierarchy of the document structure.
2915 \end_layout
2916 \begin_layout Description
2917 Notion Part <- Chapter <- Section <- etc.
2918 \end_layout
2919 \begin_layout Description
2920 Syntax outline-out
2921 \end_layout
2922 \begin_layout Description
2923 Origin Vermeer, 23 Mar 2006
2924 \end_layout
2925
2926 \begin_layout Subsection*
2927 LFUN_INSET_EDIT
2928 \end_layout
2929 \begin_layout Description
2930 Action Edit the inset at cursor with an external application, if one is attributed.
2931 \end_layout
2932 \begin_layout Description
2933 Syntax inset-edit [<INSET_PARAMS>]
2934 \end_layout
2935 \begin_layout Description
2936 Params <INSET_PARAMS>: Parameters for the inset.
2937 \begin_inset Newline newline
2938 \end_inset
2939
2940 Currently only the filename will be considered.
2941 \end_layout
2942 \begin_layout Description
2943 Origin JSpitzm, 27 Apr 2006
2944 \end_layout
2945
2946 \begin_layout Subsection*
2947 LFUN_TABULAR_INSERT
2948 \end_layout
2949 \begin_layout Description
2950 Action Inserts table into the document.
2951 \end_layout
2952 \begin_layout Description
2953 Syntax tabular-insert [<ROWS> <COLUMNS>]
2954 \end_layout
2955 \begin_layout Description
2956 Params In case no arguments are given show insert dialog.
2957 \end_layout
2958 \begin_layout Description
2959 Origin Jug, 12 Apr 2000
2960 \end_layout
2961
2962 \begin_layout Subsection*
2963 LFUN_TABULAR_FEATURE
2964 \end_layout
2965 \begin_layout Description
2966 Action Sets various features to the table/cell on the current cursor position.
2967 \end_layout
2968 \begin_layout Description
2969 Notion Various math-environment features are handled here as well, e.g. add-vline-left/right for the Grid/Array environment
2970 \end_layout
2971 \begin_layout Description
2972 Syntax tabular-feature <FEATURE> [<ARG>]
2973 \end_layout
2974 \begin_layout Description
2975 Params <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|copy-column| toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right| align-left|align-right|align-center|align-block|valign-top|valign-bottom| valign-middle|m-align-left|m-align-right|m-align-center|m-valign-top| m-valign-bottom|m-valign-middle|multicolumn|set-all-lines|unset-all-lines| set-longtabular|unset-longtabular|set-pwidth|set-mpwidth| set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular| set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead| unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot| set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption| set-special-column|set-special-multi|set-booktabs|unset-booktabs| set-top-space|set-bottom-space|set-interline-space|set-border-lines| tabular-valign-top|tabular-valign-middle|tabular-valign-bottom
2976 \begin_inset Newline newline
2977 \end_inset
2978
2979 <ARG>: additional argument for some commands, use debug mode to explore its values.
2980 \end_layout
2981 \begin_layout Description
2982 Origin Jug, 28 Jul 2000
2983 \end_layout
2984
2985 \begin_layout Subsection*
2986 LFUN_CELL_BACKWARD
2987 \end_layout
2988 \begin_layout Description
2989 Action Moves the cursor to the previous cell inside the table.
2990 \end_layout
2991 \begin_layout Description
2992 Syntax cell-backward
2993 \end_layout
2994 \begin_layout Description
2995 Origin Jug, 22 May 2000
2996 \end_layout
2997
2998 \begin_layout Subsection*
2999 LFUN_CELL_FORWARD
3000 \end_layout
3001 \begin_layout Description
3002 Action Moves the cursor to the next cell inside the table.
3003 \end_layout
3004 \begin_layout Description
3005 Syntax cell-forward
3006 \end_layout
3007
3008 \begin_layout Subsection*
3009 LFUN_CELL_SPLIT
3010 \end_layout
3011 \begin_layout Description
3012 Action Splits cell and shifts right part to the next cell (inside the math grid).
3013 \end_layout
3014 \begin_layout Description
3015 Syntax cell-split
3016 \end_layout
3017 \begin_layout Description
3018 Origin Ale, 15 May 1997
3019 \end_layout
3020
3021 \begin_layout Subsection*
3022 LFUN_VC_REGISTER
3023 \end_layout
3024 \begin_layout Description
3025 Action Register the document as an file inside version control system (RCS, CVS).
3026 \end_layout
3027 \begin_layout Description
3028 Notion File is registered inside cvs, svn or rcs repository acording to the existence of cvs/svn/rcs entries in the document's directory.
3029 \begin_inset Newline newline
3030 \end_inset
3031
3032 See LyX Additional Features Manual (Version Control Chapter) for additional information.
3033 \end_layout
3034 \begin_layout Description
3035 Syntax vc-register
3036 \end_layout
3037 \begin_layout Description
3038 Origin Lgb, 1 Jul 1997
3039 \end_layout
3040
3041 \begin_layout Subsection*
3042 LFUN_VC_CHECK_IN
3043 \end_layout
3044 \begin_layout Description
3045 Action Checks-in/commits the changes of the registered file to the repository.
3046 \end_layout
3047 \begin_layout Description
3048 Notion In RCS case this also unlocks the file.
3049 \end_layout
3050 \begin_layout Description
3051 Syntax vc-check-in
3052 \end_layout
3053 \begin_layout Description
3054 Origin Lgb, 1 Jul 1997
3055 \end_layout
3056
3057 \begin_layout Subsection*
3058 LFUN_VC_CHECK_OUT
3059 \end_layout
3060 \begin_layout Description
3061 Action Checks-out the document for edit (and locks it for RCS).
3062 \end_layout
3063 \begin_layout Description
3064 Notion This is implemented only for RCS and SVN, not CVS.
3065 \end_layout
3066 \begin_layout Description
3067 Syntax vc-check-out
3068 \end_layout
3069 \begin_layout Description
3070 Origin Lgb, 1 Jul 1997
3071 \end_layout
3072
3073 \begin_layout Subsection*
3074 LFUN_VC_REVERT
3075 \end_layout
3076 \begin_layout Description
3077 Action Reverts the document to the last check-in/commit in VCS.
3078 \end_layout
3079 \begin_layout Description
3080 Syntax vc-revert
3081 \end_layout
3082 \begin_layout Description
3083 Origin Lgb, 1 Jul 1997
3084 \end_layout
3085
3086 \begin_layout Subsection*
3087 LFUN_VC_UNDO_LAST
3088 \end_layout
3089 \begin_layout Description
3090 Action Undo last check-in.
3091 \end_layout
3092 \begin_layout Description
3093 Notion This is currently implemented only for RCS.
3094 \end_layout
3095 \begin_layout Description
3096 Syntax vc-check-out
3097 \end_layout
3098 \begin_layout Description
3099 Origin Lgb, 1 Jul 1997
3100 \end_layout
3101
3102 \begin_layout Subsection*
3103 LFUN_VC_COMMAND
3104 \end_layout
3105 \begin_layout Description
3106 Action Executes external command. This command is intended to support additional VCS commands.
3107 \end_layout
3108 \begin_layout Description
3109 Syntax vc-command <FLAG> <PATH> <COMMAND>
3110 \end_layout
3111 \begin_layout Description
3112 Params  <FLAG>: Flags for the command can be combined together.
3113 \begin_inset Newline newline
3114 \end_inset
3115
3116 U - dUmmy - no flags
3117 \begin_inset Newline newline
3118 \end_inset
3119
3120 D - Doc - need document loaded to proceed
3121 \begin_inset Newline newline
3122 \end_inset
3123
3124 I - dIrty - mark document dirty
3125 \begin_inset Newline newline
3126 \end_inset
3127
3128 R - Reload - ensure that the document is saved and reload it after command execution
3129 \begin_inset Newline newline
3130 \end_inset
3131
3132 M - Message - ask for input string (commit message)
3133 \begin_inset Newline newline
3134 \end_inset
3135
3136 <PATH>: path where to start. $$p will be replaced by the current document path.
3137 \begin_inset Newline newline
3138 \end_inset
3139
3140 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current document/path/message.
3141 \end_layout
3142 \begin_layout Description
3143 Sample vc-command DR $$p "svn up"
3144 \end_layout
3145 \begin_layout Description
3146 Origin sanda, 13 Jan 2009
3147 \end_layout
3148
3149 \begin_layout Subsection*
3150 LFUN_CHANGES_TRACK
3151 \end_layout
3152 \begin_layout Description
3153 Action Toggles change tracking to on/off.
3154 \end_layout
3155 \begin_layout Description
3156 Syntax changes-track
3157 \end_layout
3158 \begin_layout Description
3159 Origin levon, 1 Oct 2002
3160 \end_layout
3161
3162 \begin_layout Subsection*
3163 LFUN_CHANGES_OUTPUT
3164 \end_layout
3165 \begin_layout Description
3166 Action Toggles showing of change tracking in typesetted output.
3167 \end_layout
3168 \begin_layout Description
3169 Syntax changes-output
3170 \end_layout
3171 \begin_layout Description
3172 Origin jspitzm, 21 Jan 2005
3173 \end_layout
3174
3175 \begin_layout Subsection*
3176 LFUN_CHANGE_NEXT
3177 \end_layout
3178 \begin_layout Description
3179 Action Moves the cursor to the position of the next change of the change tracking records.
3180 \end_layout
3181 \begin_layout Description
3182 Syntax change-next
3183 \end_layout
3184 \begin_layout Description
3185 Origin schmitt, 4 Oct 2006
3186 \end_layout
3187
3188 \begin_layout Subsection*
3189 LFUN_CHANGE_PREVIOUS
3190 \end_layout
3191 \begin_layout Description
3192 Action Moves the cursor to the position of the previous change of the change tracking records.
3193 \end_layout
3194 \begin_layout Description
3195 Syntax change-previous
3196 \end_layout
3197 \begin_layout Description
3198 Origin vfr, 4 Apr 2009
3199 \end_layout
3200
3201 \begin_layout Subsection*
3202 LFUN_CHANGES_MERGE
3203 \end_layout
3204 \begin_layout Description
3205 Action Open change tracking dialog for merging and moves the cursor to the position of the next change.
3206 \end_layout
3207 \begin_layout Description
3208 Syntax changes-merge
3209 \end_layout
3210 \begin_layout Description
3211 Origin Levon, 16 Oct 2002
3212 \end_layout
3213
3214 \begin_layout Subsection*
3215 LFUN_CHANGE_ACCEPT
3216 \end_layout
3217 \begin_layout Description
3218 Action Accepts tracked change inside the selection.
3219 \end_layout
3220 \begin_layout Description
3221 Syntax change-accept
3222 \end_layout
3223 \begin_layout Description
3224 Origin Levon, 16 Oct 2002
3225 \end_layout
3226
3227 \begin_layout Subsection*
3228 LFUN_CHANGE_REJECT
3229 \end_layout
3230 \begin_layout Description
3231 Action Rejects tracked change inside the selection.
3232 \end_layout
3233 \begin_layout Description
3234 Syntax change-accept
3235 \end_layout
3236 \begin_layout Description
3237 Origin Levon, 16 Oct 2002
3238 \end_layout
3239
3240 \begin_layout Subsection*
3241 LFUN_ALL_CHANGES_ACCEPT
3242 \end_layout
3243 \begin_layout Description
3244 Action Accepts all tracked changes in the document.
3245 \end_layout
3246 \begin_layout Description
3247 Syntax all-changes-accept
3248 \end_layout
3249 \begin_layout Description
3250 Origin Levon, 16 Oct 2002
3251 \end_layout
3252
3253 \begin_layout Subsection*
3254 LFUN_ALL_CHANGES_REJECT
3255 \end_layout
3256 \begin_layout Description
3257 Action Rejects all tracked changes in the document.
3258 \end_layout
3259 \begin_layout Description
3260 Notion Reject does not work recursively; the user may have to repeat the operation.
3261 \end_layout
3262 \begin_layout Description
3263 Syntax all-changes-reject
3264 \end_layout
3265 \begin_layout Description
3266 Origin Levon, 16 Oct 2002
3267 \end_layout
3268
3269 \begin_layout Subsection*
3270 LFUN_INSET_APPLY
3271 \end_layout
3272 \begin_layout Description
3273 Action Apply data for an inset.
3274 \end_layout
3275 \begin_layout Description
3276 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.
3277 \end_layout
3278 \begin_layout Description
3279 Syntax inset-apply <ARGS>
3280 \end_layout
3281 \begin_layout Description
3282 Params See LFUN_INSET_INSERT .
3283 \end_layout
3284
3285 \begin_layout Subsection*
3286 LFUN_INSET_DISSOLVE
3287 \end_layout
3288 \begin_layout Description
3289 Action Dissolve the current inset into text.
3290 \end_layout
3291 \begin_layout Description
3292 Syntax inset-dissolve [<INSET>]
3293 \end_layout
3294 \begin_layout Description
3295 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.
3296 \begin_inset Newline newline
3297 \end_inset
3298
3299 For values see lyx::InsetLayout::lyxtype_ .
3300 \end_layout
3301 \begin_layout Description
3302 Origin JSpitz, 7 Aug 2006
3303 \end_layout
3304
3305 \begin_layout Subsection*
3306 LFUN_INSET_INSERT
3307 \end_layout
3308 \begin_layout Description
3309 Action Insert new inset (type given by the parameters).
3310 \end_layout
3311 \begin_layout Description
3312 Syntax inset-insert <INSET> <ARGS>
3313 \end_layout
3314 \begin_layout Description
3315 Params <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics| hyperlink|include|index|label|nomencl|vspace|ref|toc>
3316 \begin_inset Newline newline
3317 \end_inset
3318
3319 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
3320 \end_layout
3321 \begin_layout Description
3322 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
3323 \backslash
3324 end_inset
3325 \begin_inset Newline newline
3326 \end_inset
3327
3328 where <label name> is the name of the referenced label and <Format> is one of the following:
3329 \begin_inset Newline newline
3330 \end_inset
3331
3332 ref -- <reference>
3333 \begin_inset Newline newline
3334 \end_inset
3335
3336 eqref -- (<reference>)
3337 \begin_inset Newline newline
3338 \end_inset
3339
3340 pageref -- <page>
3341 \begin_inset Newline newline
3342 \end_inset
3343
3344 vpageref -- on <page>
3345 \begin_inset Newline newline
3346 \end_inset
3347
3348 vref -- <reference> on <page>
3349 \begin_inset Newline newline
3350 \end_inset
3351
3352 prettyref -- Formatted reference
3353 \end_layout
3354
3355 \begin_layout Subsection*
3356 LFUN_INSET_MODIFY
3357 \end_layout
3358 \begin_layout Description
3359 Action Modify existing inset.
3360 \end_layout
3361 \begin_layout Description
3362 Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats, graphics, include, label, listings, note, phantom, ref, space, tabular, vspace, wrap insets.
3363 \end_layout
3364 \begin_layout Description
3365 Syntax inset-modify <INSET> <ARGS>
3366 \end_layout
3367 \begin_layout Description
3368 Params See LFUN_INSET_INSERT for further details.
3369 \end_layout
3370
3371 \begin_layout Subsection*
3372 LFUN_NEXT_INSET_MODIFY
3373 \end_layout
3374 \begin_layout Description
3375 Action Modify the inset at cursor position, if there is one.
3376 \end_layout
3377 \begin_layout Description
3378 Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats, graphics, include, label, listings, note, phantom, ref, space, tabular, vspace, wrap insets.
3379 \end_layout
3380 \begin_layout Description
3381 Syntax next-inset-modify <INSET> <ARGS>next-inset-modify changetype <TYPE>
3382 \end_layout
3383 \begin_layout Description
3384 Params See LFUN_INSET_INSERT for further details.
3385 \end_layout
3386 \begin_layout Description
3387 Origin JSpitzm, 23 Mar 2008
3388 \end_layout
3389
3390 \begin_layout Subsection*
3391 LFUN_INSET_DIALOG_UPDATE
3392 \end_layout
3393 \begin_layout Description
3394 Action Updates the values inside the dialog from the inset.
3395 \end_layout
3396 \begin_layout Description
3397 Notion This is internal LFUN, not to be used by users. Called internally by LFUN_DIALOG_UPDATE
3398 \end_layout
3399 \begin_layout Description
3400 Params <DIALOG-NAME>
3401 \end_layout
3402 \begin_layout Description
3403 Origin leeming, 25 Feb 2003
3404 \end_layout
3405
3406 \begin_layout Subsection*
3407 LFUN_INSET_SETTINGS
3408 \end_layout
3409 \begin_layout Description
3410 Action Open the inset's properties dialog.
3411 \end_layout
3412 \begin_layout Description
3413 Notion Used for bibitem, bibtex, box, branch, citation, ert, external, float, graphics, href, include, index, index_print, label, listings, note, phantom, ref, space, tabular, vspace, wrap insets.
3414 \end_layout
3415 \begin_layout Description
3416 Syntax inset-settings <INSET>
3417 \end_layout
3418 \begin_layout Description
3419 Params <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float| graphics|href|include|index|index_print|label|listings| note|phantom|ref|space|tabular|vspace|wrap>.
3420 \end_layout
3421
3422 \begin_layout Subsection*
3423 LFUN_INSET_TOGGLE
3424 \end_layout
3425 \begin_layout Description
3426 Action Toggles the collapsable inset at cursor position, or the inset we are currently in.
3427 \end_layout
3428 \begin_layout Description
3429 Syntax inset-toggle [<ARG>]
3430 \end_layout
3431 \begin_layout Description
3432 Params <ARG>: <open|close|toggle|assign>.
3433 \begin_inset Newline newline
3434 \end_inset
3435
3436 open/close/toggle are for collapsable insets. toggle is used when no argument is given.
3437 \begin_inset Newline newline
3438 \end_inset
3439
3440 assign synchronize the branch-inset with activation status of the branch. Used for global toggling when changed activation.
3441 \end_layout
3442 \begin_layout Description
3443 Origin lasgouttes, 19 Jul 2001
3444 \end_layout
3445
3446 \begin_layout Subsection*
3447 LFUN_ALL_INSETS_TOGGLE
3448 \end_layout
3449 \begin_layout Description
3450 Action Toggles (open/closes) all collapsable insets (of a given type) in the document.
3451 \end_layout
3452 \begin_layout Description
3453 Notion Used for box, branch, ert, float, listings, note, tabular, wrap insets.
3454 \end_layout
3455 \begin_layout Description
3456 Syntax all-insets-toggle [<STATE>] [<INSET>]
3457 \end_layout
3458 \begin_layout Description
3459 Params <STATE>: <toggle|open|close|assign> default: toggle
3460 \begin_inset Newline newline
3461 \end_inset
3462
3463 <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets
3464 \end_layout
3465 \begin_layout Description
3466 Origin leeming, 30 Mar 2004
3467 \end_layout
3468
3469 \begin_layout Subsection*
3470 LFUN_SET_GRAPHICS_GROUP
3471 \end_layout
3472 \begin_layout Description
3473 Action Set the group for the graphics inset on the cursor position.
3474 \end_layout
3475 \begin_layout Description
3476 Syntax set-graphics-group [<GROUP>]
3477 \end_layout
3478 \begin_layout Description
3479 Params <GROUP>: Id for an existing group. In case the Id is an empty string, the graphics inset is removed from the current group.
3480 \end_layout
3481 \begin_layout Description
3482 Origin sanda, 6 May 2008
3483 \end_layout
3484
3485 \begin_layout Subsection*
3486 LFUN_FINISHED_FORWARD
3487 \end_layout
3488 \begin_layout Description
3489 Action Moves the cursor out of the current slice, going forward.
3490 \end_layout
3491 \begin_layout Description
3492 Notion Cursor movement within an inset may be different than cursor movement in the surrounding text. This action should be called automatically by the cursor movement within the inset, when movement within the inset has ceased (reached the end of the last paragraph, for example), in order to move correctly back into the surrounding text.
3493 \end_layout
3494
3495 \begin_layout Subsection*
3496 LFUN_FINISHED_BACKWARD
3497 \end_layout
3498 \begin_layout Description
3499 Action Moves the cursor out of the current slice, going backwards.
3500 \end_layout
3501 \begin_layout Description
3502 Notion See also LFUN_FINISHED_FORWARD.
3503 \end_layout
3504
3505 \begin_layout Subsection*
3506 LFUN_FINISHED_RIGHT
3507 \end_layout
3508 \begin_layout Description
3509 Action Moves the cursor out of the current slice, going right.
3510 \end_layout
3511 \begin_layout Description
3512 Notion See also LFUN_FINISHED_FORWARD
3513 \end_layout
3514
3515 \begin_layout Subsection*
3516 LFUN_FINISHED_LEFT
3517 \end_layout
3518 \begin_layout Description
3519 Action Moves the cursor out of the current slice, going left.
3520 \end_layout
3521 \begin_layout Description
3522 Notion See also LFUN_FINISHED_FORWARD.
3523 \end_layout
3524
3525 \begin_layout Subsection*
3526 LFUN_LANGUAGE
3527 \end_layout
3528 \begin_layout Description
3529 Action Set language from the current cursor position.
3530 \end_layout
3531 \begin_layout Description
3532 Syntax language <LANG>
3533 \end_layout
3534 \begin_layout Description
3535 Params <LANG>: Requested language. Look in lib/languages for the list.
3536 \end_layout
3537 \begin_layout Description
3538 Origin Dekel, 2 Mar 2000
3539 \end_layout
3540
3541 \begin_layout Subsection*
3542 LFUN_LABEL_GOTO
3543 \end_layout
3544 \begin_layout Description
3545 Action Goto a label.
3546 \end_layout
3547 \begin_layout Description
3548 Syntax label-goto [<LABEL>]
3549 \end_layout
3550 \begin_layout Description
3551 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.
3552 \end_layout
3553 \begin_layout Description
3554 Origin Ale, 6 Aug 1997
3555 \end_layout
3556
3557 \begin_layout Subsection*
3558 LFUN_LABEL_INSERT
3559 \end_layout
3560 \begin_layout Description
3561 Action Inserts label to text or displayed formula.
3562 \end_layout
3563 \begin_layout Description
3564 Syntax label-insert [<LABEL>]
3565 \end_layout
3566 \begin_layout Description
3567 Params <LABEL>: Requested label. If no label is given dialog requesting name will be opened.
3568 \end_layout
3569
3570 \begin_layout Subsection*
3571 LFUN_REFERENCE_NEXT
3572 \end_layout
3573 \begin_layout Description
3574 Action Go to the next label or cross-reference.
3575 \end_layout
3576 \begin_layout Description
3577 Syntax reference-next
3578 \end_layout
3579 \begin_layout Description
3580 Origin Dekel, 14 Jan 2001
3581 \end_layout
3582
3583 \begin_layout Subsection*
3584 LFUN_BOOKMARK_GOTO
3585 \end_layout
3586 \begin_layout Description
3587 Action Moves the cursor to the numbered bookmark, opening the file if necessary. Note that bookmarsk are saved per-session, not per file.
3588 \end_layout
3589 \begin_layout Description
3590 Notion Bookmark 0 has a special purpose. It is automatically set
3591 \begin_inset Newline newline
3592 \end_inset
3593
3594 1. to the paragraph you are currently editing
3595 \begin_inset Newline newline
3596 \end_inset
3597
3598 2. to the paragraph from where you are jumping to the last-edited position (jump-back feature)
3599 \begin_inset Newline newline
3600 \end_inset
3601
3602 3. when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
3603 \end_layout
3604 \begin_layout Description
3605 Syntax bookmark-goto <NUMBER>
3606 \end_layout
3607 \begin_layout Description
3608 Params <NUMBER>: the number of the bookmark to restore.
3609 \end_layout
3610 \begin_layout Description
3611 Origin Dekel, 27 January 2001
3612 \end_layout
3613
3614 \begin_layout Subsection*
3615 LFUN_BOOKMARK_SAVE
3616 \end_layout
3617 \begin_layout Description
3618 Action Save a bookmark.
3619 \end_layout
3620 \begin_layout Description
3621 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.
3622 \end_layout
3623 \begin_layout Description
3624 Syntax bookmark-save <NUMBER>
3625 \end_layout
3626 \begin_layout Description
3627 Params <NUMBER>: the number of the bookmark to save.
3628 \end_layout
3629 \begin_layout Description
3630 Origin Dekel, 27 January 2001
3631 \end_layout
3632
3633 \begin_layout Subsection*
3634 LFUN_BOOKMARK_CLEAR
3635 \end_layout
3636 \begin_layout Description
3637 Action Clears the list of saved bookmarks.
3638 \end_layout
3639 \begin_layout Description
3640 Syntax bookmark-clear
3641 \end_layout
3642 \begin_layout Description
3643 Origin bpeng, 31 October 2006
3644 \end_layout
3645
3646 \begin_layout Subsection*
3647 LFUN_HELP_OPEN
3648 \end_layout
3649 \begin_layout Description
3650 Action Open the given help file according to the language setting.
3651 \end_layout
3652 \begin_layout Description
3653 Syntax help-open <FILE>[.lyx]
3654 \end_layout
3655 \begin_layout Description
3656 Params <FILE>: any document from (/usr/share/)doc directory.
3657 \end_layout
3658 \begin_layout Description
3659 Origin Jug, 27 Jun 1999
3660 \end_layout
3661
3662 \begin_layout Subsection*
3663 LFUN_LYX_QUIT
3664 \end_layout
3665 \begin_layout Description
3666 Action Terminates the current LyX instance.
3667 \end_layout
3668 \begin_layout Description
3669 Notion Terminates the current LyX instance, asking whether to save modified documents, etc.
3670 \end_layout
3671 \begin_layout Description
3672 Syntax lyx-quit
3673 \end_layout
3674
3675 \begin_layout Subsection*
3676 LFUN_TOOLBAR_TOGGLE
3677 \end_layout
3678 \begin_layout Description
3679 Action Toggles visibility of a given toolbar between on/off/auto.
3680 \end_layout
3681 \begin_layout Description
3682 Notion Skiping "auto" when allowauto is false.
3683 \end_layout
3684 \begin_layout Description
3685 Syntax toolbar-toggle <NAME> [allowauto]
3686 \end_layout
3687 \begin_layout Description
3688 Params <NAME>: standard|extra|table|math|mathmacrotemplate| minibuffer|review|view/update|math_panels|vcs
3689 \end_layout
3690 \begin_layout Description
3691 Origin Edwin, 21 May 2007
3692 \end_layout
3693
3694 \begin_layout Subsection*
3695 LFUN_MENU_OPEN
3696 \end_layout
3697 \begin_layout Description
3698 Action Opens the menu given by its name.
3699 \end_layout
3700 \begin_layout Description
3701 Syntax menu-open <NAME>
3702 \end_layout
3703 \begin_layout Description
3704 Params <NAME>: menu name. See various .inc files in lib/ui for candidates.
3705 \end_layout
3706
3707 \begin_layout Subsection*
3708 LFUN_UI_TOGGLE
3709 \end_layout
3710 \begin_layout Description
3711 Action Various UI visibility-toggling actions.
3712 \end_layout
3713 \begin_layout Description
3714 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
3715 \end_layout
3716 \begin_layout Description
3717 Params statusbar  : Toggle visibility of the statusbar.
3718 \begin_inset Newline newline
3719 \end_inset
3720
3721 menubar    : Toggle visibility of the menubar.
3722 \begin_inset Newline newline
3723 \end_inset
3724
3725 scrollbar  : Toggle visibility of the scrollbar.
3726 \begin_inset Newline newline
3727 \end_inset
3728
3729 frame      : Toggle visibility of the frames around editing window.
3730 \begin_inset Newline newline
3731 \end_inset
3732
3733 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.
3734 \end_layout
3735 \begin_layout Description
3736 Origin sanda, 9 Feb 2007
3737 \end_layout
3738
3739 \begin_layout Subsection*
3740 LFUN_WINDOW_NEW
3741 \end_layout
3742 \begin_layout Description
3743 Action Creates new empty LyX window.
3744 \end_layout
3745 \begin_layout Description
3746 Notion Already opened documents from the previous window can be found under View menu.
3747 \end_layout
3748 \begin_layout Description
3749 Syntax window-new [<GEOMETRY>]
3750 \end_layout
3751 \begin_layout Description
3752 Params <GEOMETRY>: pass the geometry of the window. This parameter is currently accepted only on Windows platform.
3753 \end_layout
3754 \begin_layout Description
3755 Origin Abdel, 21 Oct 2006
3756 \end_layout
3757
3758 \begin_layout Subsection*
3759 LFUN_WINDOW_CLOSE
3760 \end_layout
3761 \begin_layout Description
3762 Action Closes the current LyX window.
3763 \end_layout
3764 \begin_layout Description
3765 Syntax window-close
3766 \end_layout
3767 \begin_layout Description
3768 Origin Abdel, 23 Oct 2006
3769 \end_layout
3770
3771 \begin_layout Subsection*
3772 LFUN_SPLIT_VIEW
3773 \end_layout
3774 \begin_layout Description
3775 Action Creates another split view of current buffer.
3776 \end_layout
3777 \begin_layout Description
3778 Notion All split views act in the same way indpendently.
3779 \end_layout
3780 \begin_layout Description
3781 Syntax split-view <vertical|horizontal>
3782 \end_layout
3783 \begin_layout Description
3784 Params horizontal : The work areas are laid out side by side.
3785 \begin_inset Newline newline
3786 \end_inset
3787
3788 vertical   : The work areas laid out vertically.
3789 \end_layout
3790 \begin_layout Description
3791 Origin Abdel, 20 Feb 2008
3792 \end_layout
3793
3794 \begin_layout Subsection*
3795 LFUN_CLOSE_TAB_GROUP
3796 \end_layout
3797 \begin_layout Description
3798 Action Close the current tab group.
3799 \end_layout
3800 \begin_layout Description
3801 Notion This only closes the work areas, not the buffer themselves. The still opened buffers can be visualized in another tab group.
3802 \end_layout
3803 \begin_layout Description
3804 Syntax close-tab-group
3805 \end_layout
3806 \begin_layout Description
3807 Origin Abdel, 21 Feb 2008
3808 \end_layout
3809
3810 \begin_layout Subsection*
3811 LFUN_DIALOG_SHOW
3812 \end_layout
3813 \begin_layout Description
3814 Action Shows hidden dialog or create new one for a given function/inset settings etc.
3815 \end_layout
3816 \begin_layout Description
3817 Syntax dialog-show <NAME> [<DATA>]
3818 \end_layout
3819 \begin_layout Description
3820 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
3821 \begin_inset Newline newline
3822 \end_inset
3823
3824 document|errorlist|ert|external|file|findreplace|findreplaceadv|float|graphics|
3825 \begin_inset Newline newline
3826 \end_inset
3827
3828 href|include|index|index_print|info|label|listings|log|mathdelimiter|
3829 \begin_inset Newline newline
3830 \end_inset
3831
3832 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|
3833 \begin_inset Newline newline
3834 \end_inset
3835
3836 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|
3837 \begin_inset Newline newline
3838 \end_inset
3839
3840 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL>
3841 \begin_inset Newline newline
3842 \end_inset
3843
3844 <SPECIAL>: latexlog|vclog
3845 \begin_inset Newline newline
3846 \end_inset
3847
3848 <DATA>: data, usually settings for the given dialog. Use debug mode for the details.
3849 \end_layout
3850 \begin_layout Description
3851 Origin leeming, 17 Jun 2003
3852 \end_layout
3853
3854 \begin_layout Subsection*
3855 LFUN_DIALOG_SHOW_NEW_INSET
3856 \end_layout
3857 \begin_layout Description
3858 Action Shows hidden dialog or create new one for a given inset settings etc.
3859 \end_layout
3860 \begin_layout Description
3861 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given inset.
3862 \end_layout
3863 \begin_layout Description
3864 Syntax dialog-show-new-inset <NAME> [<DATA>]
3865 \end_layout
3866 \begin_layout Description
3867 Params See LFUN_DIALOG_SHOW .
3868 \end_layout
3869 \begin_layout Description
3870 Origin leeming, 25 Feb 2003
3871 \end_layout
3872
3873 \begin_layout Subsection*
3874 LFUN_DIALOG_UPDATE
3875 \end_layout
3876 \begin_layout Description
3877 Action Updates the dialog values from the inset/paragraph/document.
3878 \end_layout
3879 \begin_layout Description
3880 Syntax dialog-update <NAME>
3881 \end_layout
3882 \begin_layout Description
3883 Params <NAME>: paragraph|prefs|<INSET>
3884 \begin_inset Newline newline
3885 \end_inset
3886
3887 <INSET>: inset name
3888 \end_layout
3889 \begin_layout Description
3890 Origin leeming, 25 Feb 2003
3891 \end_layout
3892
3893 \begin_layout Subsection*
3894 LFUN_DIALOG_HIDE
3895 \end_layout
3896 \begin_layout Description
3897 Action Hides showed dialog. Counterpart to LFUN_DIALOG_SHOW .
3898 \end_layout
3899 \begin_layout Description
3900 Syntax dialog-hide <NAME>
3901 \end_layout
3902 \begin_layout Description
3903 Params See LFUN_DIALOG_SHOW .
3904 \end_layout
3905 \begin_layout Description
3906 Origin leeming, 25 Feb 2003
3907 \end_layout
3908
3909 \begin_layout Subsection*
3910 LFUN_DIALOG_TOGGLE
3911 \end_layout
3912 \begin_layout Description
3913 Action Toggles dialog between showed/hidden state.
3914 \end_layout
3915 \begin_layout Description
3916 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
3917 \end_layout
3918 \begin_layout Description
3919 Syntax dialog-toggle <NAME> [<DATA>]
3920 \end_layout
3921 \begin_layout Description
3922 Params See LFUN_DIALOG_SHOW .
3923 \end_layout
3924 \begin_layout Description
3925 Origin JSpitzm, 30 Apr 2007
3926 \end_layout
3927
3928 \begin_layout Subsection*
3929 LFUN_DIALOG_DISCONNECT_INSET
3930 \end_layout
3931 \begin_layout Description
3932 Action Closes opened connection to opened inset.
3933 \end_layout
3934 \begin_layout Description
3935 Notion Connection is used for apply functions.
3936 \end_layout
3937 \begin_layout Description
3938 Syntax dialog-disconnect-inset <INSET-NAME>
3939 \end_layout
3940 \begin_layout Description
3941 Origin leeming, 25 Feb 2003
3942 \end_layout
3943
3944 \begin_layout Subsection*
3945 LFUN_MOUSE_PRESS
3946 \end_layout
3947 \begin_layout Description
3948 Action This function is called when mouse button is pressed (inside workarea). Action depends on the context.
3949 \end_layout
3950 \begin_layout Description
3951 Notion This is internal LFUN, not to be used by users.
3952 \end_layout
3953 \begin_layout Description
3954 Origin Andre, 9 Aug 2002
3955 \end_layout
3956
3957 \begin_layout Subsection*
3958 LFUN_MOUSE_DOUBLE
3959 \end_layout
3960 \begin_layout Description
3961 Action This function is called when double click on mouse button is pressed (inside workarea). Action depends on the context.
3962 \end_layout
3963 \begin_layout Description
3964 Notion This is internal LFUN, not to be used by users.
3965 \end_layout
3966 \begin_layout Description
3967 Origin Andre, 9 Aug 2002
3968 \end_layout
3969
3970 \begin_layout Subsection*
3971 LFUN_MOUSE_TRIPLE
3972 \end_layout
3973 \begin_layout Description
3974 Action This function is called when triple click on mouse button is pressed (inside workarea). Action depends on the context.
3975 \end_layout
3976 \begin_layout Description
3977 Notion This is internal LFUN, not to be used by users.
3978 \end_layout
3979 \begin_layout Description
3980 Origin Andre, 9 Aug 2002
3981 \end_layout
3982
3983 \begin_layout Subsection*
3984 LFUN_MOUSE_MOTION
3985 \end_layout
3986 \begin_layout Description
3987 Action This function is called when mouse cursor is moving over the text. Action depends on the context.
3988 \end_layout
3989 \begin_layout Description
3990 Notion This is internal LFUN, not to be used by users.
3991 \end_layout
3992 \begin_layout Description
3993 Origin Andre, 9 Aug 2002
3994 \end_layout
3995
3996 \begin_layout Subsection*
3997 LFUN_MOUSE_RELEASE
3998 \end_layout
3999 \begin_layout Description
4000 Action This function is called when mouse button is released (inside workarea). Action depends on the context.
4001 \end_layout
4002 \begin_layout Description
4003 Notion This is internal LFUN, not to be used by users.
4004 \end_layout
4005 \begin_layout Description
4006 Origin Andre, 9 Aug 2002
4007 \end_layout
4008
4009 \begin_layout Subsection*
4010 LFUN_KEYMAP_OFF
4011 \end_layout
4012 \begin_layout Description
4013 Action Turn off the loaded keyboard map.
4014 \end_layout
4015 \begin_layout Description
4016 Syntax keymap-off
4017 \end_layout
4018
4019 \begin_layout Subsection*
4020 LFUN_KEYMAP_PRIMARY
4021 \end_layout
4022 \begin_layout Description
4023 Action Turn on the primary keyboard map.
4024 \end_layout
4025 \begin_layout Description
4026 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 plaforms.
4027 \begin_inset Newline newline
4028 \end_inset
4029
4030 The language is to be set in the Preferences dialog.
4031 \end_layout
4032 \begin_layout Description
4033 Syntax keymap-primary
4034 \end_layout
4035
4036 \begin_layout Subsection*
4037 LFUN_KEYMAP_SECONDARY
4038 \end_layout
4039 \begin_layout Description
4040 Action Turn on the secondary keyboard map.
4041 \end_layout
4042 \begin_layout Description
4043 Syntax keymap-secondary
4044 \end_layout
4045
4046 \begin_layout Subsection*
4047 LFUN_KEYMAP_TOGGLE
4048 \end_layout
4049 \begin_layout Description
4050 Action Toggles keyboard maps (first/second/off).
4051 \end_layout
4052 \begin_layout Description
4053 Syntax keymap-toggle
4054 \end_layout
4055 \begin_layout Description
4056 Origin leeming, 30 Mar 2004
4057 \end_layout
4058
4059 \begin_layout Subsection*
4060 LFUN_SERVER_GET_LAYOUT
4061 \end_layout
4062 \begin_layout Description
4063 Action Returns the current layout (that is environment) name on the cursor position.
4064 \end_layout
4065 \begin_layout Description
4066 Syntax server-get-layout
4067 \end_layout
4068
4069 \begin_layout Subsection*
4070 LFUN_SERVER_GET_FILENAME
4071 \end_layout
4072 \begin_layout Description
4073 Action Returns path and file name of the currently edited document.
4074 \end_layout
4075 \begin_layout Description
4076 Syntax server-get-filename
4077 \end_layout
4078
4079 \begin_layout Subsection*
4080 LFUN_SERVER_GOTO_FILE_ROW
4081 \end_layout
4082 \begin_layout Description
4083 Action Sets the cursor position based on the row number of generated TeX file.
4084 \end_layout
4085 \begin_layout Description
4086 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).
4087 \end_layout
4088 \begin_layout Description
4089 Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
4090 \end_layout
4091 \begin_layout Description
4092 Params <FILE>: the filename. Environment variables are expaned in the path. In case this LFUN does not work make sure you are giving correct path to the file.
4093 \begin_inset Newline newline
4094 \end_inset
4095
4096 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). .ext: extensions will be automatically replaced by .lyx.
4097 \end_layout
4098 \begin_layout Description
4099 Origin Edmar, 23 Dec 1998
4100 \end_layout
4101
4102 \begin_layout Subsection*
4103 LFUN_SERVER_NOTIFY
4104 \end_layout
4105 \begin_layout Description
4106 Action Sends notify message about the last key-sequence to client.
4107 \end_layout
4108 \begin_layout Description
4109 Notion This can be used to grab last key-sequence used inside the LyX window. See also Debug extensions section in Additional features manual.
4110 \end_layout
4111 \begin_layout Description
4112 Syntax server-notify
4113 \end_layout
4114
4115 \begin_layout Subsection*
4116 LFUN_SERVER_SET_XY
4117 \end_layout
4118 \begin_layout Description
4119 Action Sets the cursor position based on the editing area coordinates (similar as clicking on that point with left mouse button).
4120 \end_layout
4121 \begin_layout Description
4122 Syntax server-set-xy <X> <Y>
4123 \end_layout
4124
4125 \begin_layout Subsection*
4126 LFUN_SERVER_GET_XY
4127 \end_layout
4128 \begin_layout Description
4129 Action Returns the coordinates of cursor position in the editing area.
4130 \end_layout
4131 \begin_layout Description
4132 Syntax server-get-xy
4133 \end_layout
4134
4135 \begin_layout Subsection*
4136 LFUN_BUILD_PROGRAM
4137 \end_layout
4138 \begin_layout Description
4139 Action Generates the code (literate programming).
4140 \end_layout
4141 \begin_layout Description
4142 Notion Latex file with extension 
4143 \backslash
4144 literate_extension is generated. Then LyX invokes 
4145 \backslash
4146 build_command (with a default of``make'') to generate the code and 
4147 \backslash
4148 build_error_filter to process the compilation error messages.
4149 \begin_inset Newline newline
4150 \end_inset
4151
4152 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:
4153 \begin_inset Newline newline
4154 \end_inset
4155
4156
4157 \backslash
4158 build_command "my_script my_arguments"
4159 \begin_inset Newline newline
4160 \end_inset
4161
4162 The 
4163 \backslash
4164 build_error_filter differs from the 
4165 \backslash
4166 literate_error_filter only in that the former will identify error messages from your compiler.
4167 \end_layout
4168 \begin_layout Description
4169 Syntax build-program
4170 \end_layout
4171
4172 \begin_layout Subsection*
4173 LFUN_BUFFER_AUTO_SAVE
4174 \end_layout
4175 \begin_layout Description
4176 Action Saves the current buffer to a temporary file.
4177 \end_layout
4178 \begin_layout Description
4179 Notion Saves the current buffer to a file named "#filename#". This LFUN is called automatically by LyX, to "autosave" the current buffer.
4180 \end_layout
4181 \begin_layout Description
4182 Syntax buffer-auto-save
4183 \end_layout
4184
4185 \begin_layout Subsection*
4186 LFUN_BUFFER_CHILD_OPEN
4187 \end_layout
4188 \begin_layout Description
4189 Action Loads the given child document.
4190 \end_layout
4191 \begin_layout Description
4192 Notion The current document is treated as a parent.
4193 \end_layout
4194 \begin_layout Description
4195 Syntax buffer-child-open <FILE>
4196 \end_layout
4197 \begin_layout Description
4198 Params <FILE>: Filename of the child. The directory of the parent is assumed by default.
4199 \end_layout
4200 \begin_layout Description
4201 Origin Ale, 28 May 1997
4202 \end_layout
4203
4204 \begin_layout Subsection*
4205 LFUN_BUFFER_CHKTEX
4206 \end_layout
4207 \begin_layout Description
4208 Action Runs chktex for the current document.
4209 \end_layout
4210 \begin_layout Description
4211 Syntax buffer-chktex
4212 \end_layout
4213 \begin_layout Description
4214 Origin Asger, 30 Oct 1997
4215 \end_layout
4216
4217 \begin_layout Subsection*
4218 LFUN_BUFFER_TOGGLE_COMPRESSION
4219 \end_layout
4220 \begin_layout Description
4221 Action Toggles compression of the current document on/off.
4222 \end_layout
4223 \begin_layout Description
4224 Syntax buffer-toggle-compression
4225 \end_layout
4226 \begin_layout Description
4227 Origin bpeng, 27 Apr 2006
4228 \end_layout
4229
4230 \begin_layout Subsection*
4231 LFUN_BUFFER_CLOSE
4232 \end_layout
4233 \begin_layout Description
4234 Action Closes the current buffer.
4235 \end_layout
4236 \begin_layout Description
4237 Notion Closes the current buffer, asking whether to save it, etc, if the buffer has been modified.
4238 \end_layout
4239 \begin_layout Description
4240 Syntax buffer-close
4241 \end_layout
4242
4243 \begin_layout Subsection*
4244 LFUN_BUFFER_EXPORT
4245 \end_layout
4246 \begin_layout Description
4247 Action Exports the current buffer (document) to the given format.
4248 \end_layout
4249 \begin_layout Description
4250 Syntax buffer-export <FORMAT>
4251 \end_layout
4252 \begin_layout Description
4253 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.
4254 \begin_inset Newline newline
4255 \end_inset
4256
4257 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.
4258 \end_layout
4259 \begin_layout Description
4260 Origin Lgb, 29 Jul 1997
4261 \end_layout
4262
4263 \begin_layout Subsection*
4264 LFUN_BUFFER_EXPORT_CUSTOM
4265 \end_layout
4266 \begin_layout Description
4267 Action Exports the current buffer (document) from the given format using the given command on it.
4268 \end_layout
4269 \begin_layout Description
4270 Syntax buffer-export-custom <FORMAT> <COMMAND>
4271 \end_layout
4272 \begin_layout Description
4273 Params <FORMAT> format to start from (LyX will care to produce such intermediate file).
4274 \begin_inset Newline newline
4275 \end_inset
4276
4277 <COMMAND> this command will be launched on the file. Note that you can use "$$FName" string to qualify the intermediate file.
4278 \end_layout
4279 \begin_layout Description
4280 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
4281 \end_layout
4282 \begin_layout Description
4283 Origin leeming, 27 Mar 2004
4284 \end_layout
4285
4286 \begin_layout Subsection*
4287 LFUN_BUFFER_PRINT
4288 \end_layout
4289 \begin_layout Description
4290 Action Prints the current document.
4291 \end_layout
4292 \begin_layout Description
4293 Notion Many settings can be given via the preferences dialog.
4294 \end_layout
4295 \begin_layout Description
4296 Syntax buffer-print <TARGET> <TARGET-NAME> <COMMAND>
4297 \end_layout
4298 \begin_layout Description
4299 Params <TARGET> is either "printer" or "file".
4300 \begin_inset Newline newline
4301 \end_inset
4302
4303 <TARGER-NAME> is either "default" or file name or printer name.
4304 \begin_inset Newline newline
4305 \end_inset
4306
4307 <COMMAND> command ensuring the printing job.
4308 \end_layout
4309 \begin_layout Description
4310 Sample buffer-print file "/trash/newfile1.ps" "dvips"
4311 \end_layout
4312 \begin_layout Description
4313 Origin leeming, 28 Mar 2004
4314 \end_layout
4315
4316 \begin_layout Subsection*
4317 LFUN_BUFFER_IMPORT
4318 \end_layout
4319 \begin_layout Description
4320 Action Import a given file as a lyx document.
4321 \end_layout
4322 \begin_layout Description
4323 Notion File can be imported iff lyx file format is (transitively) reachable via defined convertors in preferences. Look into File->Import menu to get an idea of the currently active import formats.
4324 \end_layout
4325 \begin_layout Description
4326 Syntax buffer-import <FORMAT> [<FILE>]
4327 \end_layout
4328 \begin_layout Description
4329 Origin Asger, 24 Jul 1998
4330 \end_layout
4331
4332 \begin_layout Subsection*
4333 LFUN_BUFFER_NEW
4334 \end_layout
4335 \begin_layout Description
4336 Action Creates a new buffer (that is, document).
4337 \end_layout
4338 \begin_layout Description
4339 Notion Implicit path can be set in Preferences dialog.
4340 \end_layout
4341 \begin_layout Description
4342 Syntax buffer-new [<FILE>]
4343 \end_layout
4344 \begin_layout Description
4345 Params <FILE>: filename of created file with absolute path.
4346 \end_layout
4347
4348 \begin_layout Subsection*
4349 LFUN_BUFFER_NEW_TEMPLATE
4350 \end_layout
4351 \begin_layout Description
4352 Action Creates a new buffer (that is, document) from a template.
4353 \end_layout
4354 \begin_layout Description
4355 Notion Path for new files and templates can be set in Preferences dialog. Template will be asked for via Open-dialog.
4356 \end_layout
4357 \begin_layout Description
4358 Syntax buffer-new-template [<FILE>]
4359 \end_layout
4360 \begin_layout Description
4361 Params <FILE>: filename of created file with absolute path.
4362 \end_layout
4363
4364 \begin_layout Subsection*
4365 LFUN_BUFFER_RELOAD
4366 \end_layout
4367 \begin_layout Description
4368 Action Reverts opened document.
4369 \end_layout
4370 \begin_layout Description
4371 Syntax buffer-reload
4372 \end_layout
4373 \begin_layout Description
4374 Origin Asger, 2 Feb 1997
4375 \end_layout
4376
4377 \begin_layout Subsection*
4378 LFUN_BUFFER_SWITCH
4379 \end_layout
4380 \begin_layout Description
4381 Action Switch to the given buffer.
4382 \end_layout
4383 \begin_layout Description
4384 Notion This is useful also in case you need simultaneously more views of the edited document in different LyX windows.
4385 \end_layout
4386 \begin_layout Description
4387 Syntax buffer-new-template <BUFFER>
4388 \end_layout
4389 \begin_layout Description
4390 Params <BUFFER>: already opened document which is to be shown.
4391 \end_layout
4392
4393 \begin_layout Subsection*
4394 LFUN_BUFFER_TOGGLE_READ_ONLY
4395 \end_layout
4396 \begin_layout Description
4397 Action Toggle editing mode of the current document between read/write and read-only.
4398 \end_layout
4399 \begin_layout Description
4400 Notion In the ->Readonly mode checks-in/commits the data if the file is under version control. In the Readonly-> mode checkouts the data from repository.
4401 \begin_inset Newline newline
4402 \end_inset
4403
4404 If these operations fail, buffer won't be toggled.
4405 \end_layout
4406 \begin_layout Description
4407 Syntax buffer-toggle-read-only
4408 \end_layout
4409 \begin_layout Description
4410 Origin Lgb, 27 May 1997
4411 \end_layout
4412
4413 \begin_layout Subsection*
4414 LFUN_BUFFER_VIEW
4415 \end_layout
4416 \begin_layout Description
4417 Action Displays current buffer in chosen format.
4418 \end_layout
4419 \begin_layout Description
4420 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.
4421 \end_layout
4422 \begin_layout Description
4423 Syntax buffer-view [<FORMAT>]
4424 \end_layout
4425 \begin_layout Description
4426 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.
4427 \end_layout
4428
4429 \begin_layout Subsection*
4430 LFUN_BUFFER_UPDATE
4431 \end_layout
4432 \begin_layout Description
4433 Action Exports the current document and put the result into the temporary directory.
4434 \end_layout
4435 \begin_layout Description
4436 Notion In case you are already viewing the exported document (see LFUN_BUFFER_VIEW) the output will be rewriten - updated. This is useful in case your viewer is able to detect such changes (e.g. ghostview for postscript).
4437 \end_layout
4438 \begin_layout Description
4439 Syntax buffer-update [<FORMAT>]
4440 \end_layout
4441 \begin_layout Description
4442 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.
4443 \end_layout
4444 \begin_layout Description
4445 Origin Dekel, 5 Aug 2000
4446 \end_layout
4447
4448 \begin_layout Subsection*
4449 LFUN_BUFFER_WRITE
4450 \end_layout
4451 \begin_layout Description
4452 Action Saves the current buffer.
4453 \end_layout
4454 \begin_layout Description
4455 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.
4456 \end_layout
4457 \begin_layout Description
4458 Syntax buffer-write
4459 \end_layout
4460
4461 \begin_layout Subsection*
4462 LFUN_BUFFER_WRITE_AS
4463 \end_layout
4464 \begin_layout Description
4465 Action Rename and save current buffer.
4466 \end_layout
4467 \begin_layout Description
4468 Syntax buffer-write-as <FILENAME>
4469 \end_layout
4470 \begin_layout Description
4471 Params <FILENAME>: New name of the buffer/file. A relative path is with respect to the original location of the buffer/file.
4472 \end_layout
4473
4474 \begin_layout Subsection*
4475 LFUN_BUFFER_WRITE_ALL
4476 \end_layout
4477 \begin_layout Description
4478 Action Save all changed documents.
4479 \end_layout
4480 \begin_layout Description
4481 Syntax buffer-write-all
4482 \end_layout
4483 \begin_layout Description
4484 Origin rgh, gpothier 6 Aug 2007
4485 \end_layout
4486
4487 \begin_layout Subsection*
4488 LFUN_BUFFER_NEXT
4489 \end_layout
4490 \begin_layout Description
4491 Action Switch to the next opened document.
4492 \end_layout
4493 \begin_layout Description
4494 Notion Note that this does not necessarily mean next in tabbar (for full list see View menu).
4495 \end_layout
4496 \begin_layout Description
4497 Syntax buffer-next
4498 \end_layout
4499
4500 \begin_layout Subsection*
4501 LFUN_BUFFER_PREVIOUS
4502 \end_layout
4503 \begin_layout Description
4504 Action Switch to the previous opened document.
4505 \end_layout
4506 \begin_layout Description
4507 Syntax buffer-previous
4508 \end_layout
4509
4510 \begin_layout Subsection*
4511 LFUN_MASTER_BUFFER_UPDATE
4512 \end_layout
4513 \begin_layout Description
4514 Action When run from a child document, this updates (exports) document built from the master buffer, if available.
4515 \end_layout
4516 \begin_layout Description
4517 Syntax master-buffer-update [<FORMAT>]
4518 \end_layout
4519 \begin_layout Description
4520 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.
4521 \end_layout
4522 \begin_layout Description
4523 Origin Tommaso, 20 Sep 2007
4524 \end_layout
4525
4526 \begin_layout Subsection*
4527 LFUN_MASTER_BUFFER_VIEW
4528 \end_layout
4529 \begin_layout Description
4530 Action When run from a child document, this command shows a preview built from the master buffer, if available.
4531 \end_layout
4532 \begin_layout Description
4533 Syntax master-buffer-view [<FORMAT>]
4534 \end_layout
4535 \begin_layout Description
4536 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.
4537 \end_layout
4538 \begin_layout Description
4539 Origin Tommaso, 20 Sep 2007
4540 \end_layout
4541
4542 \begin_layout Subsection*
4543 LFUN_BUFFER_LANGUAGE
4544 \end_layout
4545 \begin_layout Description
4546 Action Set language of the current document.
4547 \end_layout
4548 \begin_layout Description
4549 Syntax buffer-language <LANG>
4550 \end_layout
4551 \begin_layout Description
4552 Params <LANG>: language name. See lib/languages for list.
4553 \end_layout
4554 \begin_layout Description
4555 Origin leeming, 30 Mar 2004
4556 \end_layout
4557
4558 \begin_layout Subsection*
4559 LFUN_BUFFER_SAVE_AS_DEFAULT
4560 \end_layout
4561 \begin_layout Description
4562 Action Save the current document settings as default.
4563 \end_layout
4564 \begin_layout Description
4565 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
4566 \end_layout
4567 \begin_layout Description
4568 Syntax buffer-save-as-default [<ARGS>]
4569 \end_layout
4570 \begin_layout Description
4571 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
4572 \end_layout
4573 \begin_layout Description
4574 Origin leeming, 30 Mar 2004
4575 \end_layout
4576
4577 \begin_layout Subsection*
4578 LFUN_BUFFER_PARAMS_APPLY
4579 \end_layout
4580 \begin_layout Description
4581 Action Apply the given settings to the current document.
4582 \end_layout
4583 \begin_layout Description
4584 Syntax buffer-params-apply [<ARGS>]
4585 \end_layout
4586 \begin_layout Description
4587 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
4588 \end_layout
4589 \begin_layout Description
4590 Origin leeming, 30 Mar 2004
4591 \end_layout
4592
4593 \begin_layout Subsection*
4594 LFUN_FILE_INSERT
4595 \end_layout
4596 \begin_layout Description
4597 Action Inserts another LyX file.
4598 \end_layout
4599 \begin_layout Description
4600 Syntax file-insert [<FILE>]
4601 \end_layout
4602 \begin_layout Description
4603 Params <FILE>: Filename to be inserted.
4604 \end_layout
4605
4606 \begin_layout Subsection*
4607 LFUN_FILE_INSERT_PLAINTEXT
4608 \end_layout
4609 \begin_layout Description
4610 Action Inserts plain text file.
4611 \end_layout
4612 \begin_layout Description
4613 Syntax file-insert-plaintext [<FILE>]
4614 \end_layout
4615 \begin_layout Description
4616 Params <FILE>: Filename to be inserted.
4617 \end_layout
4618 \begin_layout Description
4619 Origin CFO-G, 19 Nov 1997
4620 \end_layout
4621
4622 \begin_layout Subsection*
4623 LFUN_FILE_INSERT_PLAINTEXT_PARA
4624 \end_layout
4625 \begin_layout Description
4626 Action Inserts plain text file as paragraph (i.e. join lines).
4627 \end_layout
4628 \begin_layout Description
4629 Syntax file-insert-plaintext-para [<FILE>]
4630 \end_layout
4631 \begin_layout Description
4632 Params <FILE>: Filename to be inserted.
4633 \end_layout
4634 \begin_layout Description
4635 Origin Levon, 14 Feb 2001
4636 \end_layout
4637
4638 \begin_layout Subsection*
4639 LFUN_FILE_OPEN
4640 \end_layout
4641 \begin_layout Description
4642 Action Open LyX document.
4643 \end_layout
4644 \begin_layout Description
4645 Syntax file-open [<FILE>]
4646 \end_layout
4647 \begin_layout Description
4648 Params <FILE>: Filename to be opened.
4649 \end_layout
4650
4651 \begin_layout Subsection*
4652 LFUN_CALL
4653 \end_layout
4654 \begin_layout Description
4655 Action Executes a command defined in a .def file.
4656 \end_layout
4657 \begin_layout Description
4658 Notion The definitions are by default read from lib/commands/default.def.
4659 \begin_inset Newline newline
4660 \end_inset
4661
4662 A .def file allows to define a command with 
4663 \backslash
4664 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). 
4665 \backslash
4666 def_file "FileName" allows to include another .def file.
4667 \begin_inset Newline newline
4668 \end_inset
4669
4670 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.
4671 \end_layout
4672 \begin_layout Description
4673 Syntax call <NAME>
4674 \end_layout
4675 \begin_layout Description
4676 Params <NAME>: Name of the command that must be called.
4677 \end_layout
4678 \begin_layout Description
4679 Origin broider, 2 Oct 2007
4680 \end_layout
4681
4682 \begin_layout Subsection*
4683 LFUN_META_PREFIX
4684 \end_layout
4685 \begin_layout Description
4686 Action Simulate halting Meta key (Alt key on PCs).
4687 \end_layout
4688 \begin_layout Description
4689 Notion Used for buffer editation not for GUI control.
4690 \end_layout
4691 \begin_layout Description
4692 Syntax meta-prefix
4693 \end_layout
4694
4695 \begin_layout Subsection*
4696 LFUN_CANCEL
4697 \end_layout
4698 \begin_layout Description
4699 Action Cancels sequence prepared by LFUN_META_PREFIX .
4700 \end_layout
4701 \begin_layout Description
4702 Syntax cancel
4703 \end_layout
4704
4705 \begin_layout Subsection*
4706 LFUN_COMMAND_EXECUTE
4707 \end_layout
4708 \begin_layout Description
4709 Action Opens the minibuffer toolbar so that the user can type in there.
4710 \end_layout
4711 \begin_layout Description
4712 Notion Usually bound to M-x shortcut.
4713 \end_layout
4714 \begin_layout Description
4715 Syntax command-execute
4716 \end_layout
4717
4718 \begin_layout Subsection*
4719 LFUN_COMMAND_PREFIX
4720 \end_layout
4721 \begin_layout Description
4722 Action Return the current key sequence and available options as a string.
4723 \end_layout
4724 \begin_layout Description
4725 Notion No options are added if no current map exists.
4726 \begin_inset Newline newline
4727 \end_inset
4728
4729 This is probably usable only with connection to lyxserver.
4730 \end_layout
4731 \begin_layout Description
4732 Syntax command-prefix
4733 \end_layout
4734
4735 \begin_layout Subsection*
4736 LFUN_COMMAND_SEQUENCE
4737 \end_layout
4738 \begin_layout Description
4739 Action Run more commands (LFUN and its parameters) in a sequence.
4740 \end_layout
4741 \begin_layout Description
4742 Syntax command-sequence <CMDS>
4743 \end_layout
4744 \begin_layout Description
4745 Params <CMDS>: Sequence of commands separated by semicolons.
4746 \end_layout
4747 \begin_layout Description
4748 Sample command-sequence cut; ert-insert; self-insert 
4749 \backslash
4750 ; paste; self-insert {}; inset-toggle;
4751 \end_layout
4752 \begin_layout Description
4753 Origin Andre, 11 Nov 1999
4754 \end_layout
4755
4756 \begin_layout Subsection*
4757 LFUN_COMMAND_ALTERNATIVES
4758 \end_layout
4759 \begin_layout Description
4760 Action Runs the first listed command that is enabled.
4761 \end_layout
4762 \begin_layout Description
4763 Notion This can be used to bind multiple functions to a single key, and then which one is used will depend upon the context.
4764 \end_layout
4765 \begin_layout Description
4766 Syntax command-alternatives <CMDS>
4767 \end_layout
4768 \begin_layout Description
4769 Params <CMDS>: Sequence of commands separated by semicolons.
4770 \end_layout
4771 \begin_layout Description
4772 Sample command-alternatives completion-accept;cell-forward
4773 \end_layout
4774 \begin_layout Description
4775 Origin rgh, 24 September 2008
4776 \end_layout
4777
4778 \begin_layout Subsection*
4779 LFUN_MESSAGE
4780 \end_layout
4781 \begin_layout Description
4782 Action Shows message in statusbar (for script purposes).
4783 \end_layout
4784 \begin_layout Description
4785 Syntax message <STRING>
4786 \end_layout
4787 \begin_layout Description
4788 Origin Lgb, 8 Apr 2001
4789 \end_layout
4790
4791 \begin_layout Subsection*
4792 LFUN_PREFERENCES_SAVE
4793 \end_layout
4794 \begin_layout Description
4795 Action Save user preferences.
4796 \end_layout
4797 \begin_layout Description
4798 Syntax preferences-save
4799 \end_layout
4800 \begin_layout Description
4801 Origin Lgb, 27 Nov 1999
4802 \end_layout
4803
4804 \begin_layout Subsection*
4805 LFUN_RECONFIGURE
4806 \end_layout
4807 \begin_layout Description
4808 Action Reconfigure the automatic settings.
4809 \end_layout
4810 \begin_layout Description
4811 Syntax reconfigure
4812 \end_layout
4813 \begin_layout Description
4814 Origin Asger, 14 Feb 1997
4815 \end_layout
4816
4817 \begin_layout Subsection*
4818 LFUN_LYXRC_APPLY
4819 \end_layout
4820 \begin_layout Description
4821 Action Apply the given settings to user preferences.
4822 \end_layout
4823 \begin_layout Description
4824 Syntax lyxrc-apply <SETTINGS>
4825 \end_layout
4826 \begin_layout Description
4827 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.
4828 \end_layout
4829
4830 \begin_layout Subsection*
4831 LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
4832 \end_layout
4833 \begin_layout Description
4834 Action Determine whether keep cursor inside the editing window regardless the scrollbar movement.
4835 \end_layout
4836 \begin_layout Description
4837 Syntax toggle-cursor-follows-scrollbar
4838 \end_layout
4839 \begin_layout Description
4840 Origin ARRae, 2 Dec 1997
4841 \end_layout
4842
4843 \begin_layout Subsection*
4844 LFUN_SET_COLOR
4845 \end_layout
4846 \begin_layout Description
4847 Action Set the given LyX color to the color defined by the X11 name given.
4848 \end_layout
4849 \begin_layout Description
4850 Notion A new color entry is created if the color is unknown. Color names can be stored as a part of user settings.
4851 \end_layout
4852 \begin_layout Description
4853 Syntax set-color <LYX_NAME> <X11_NAME>
4854 \end_layout
4855 \begin_layout Description
4856 Origin SLior, 11 Jun 2000
4857 \end_layout
4858
4859 \begin_layout Subsection*
4860 LFUN_STATISTICS
4861 \end_layout
4862 \begin_layout Description
4863 Action Count the statistics (number of words and characters) in the document or in the given selection.
4864 \end_layout
4865 \begin_layout Description
4866 Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
4867 \end_layout
4868 \begin_layout Description
4869 Syntax statistics
4870 \end_layout
4871 \begin_layout Description
4872 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
4873 \end_layout
4874
4875 \begin_layout Subsection*
4876 LFUN_COMPLETION_INLINE
4877 \end_layout
4878 \begin_layout Description
4879 Action Show the inline completion at the cursor position.
4880 \end_layout
4881 \begin_layout Description
4882 Syntax completion-inline
4883 \end_layout
4884 \begin_layout Description
4885 Origin sts, Feb 19 2008
4886 \end_layout
4887
4888 \begin_layout Subsection*
4889 LFUN_COMPLETION_POPUP
4890 \end_layout
4891 \begin_layout Description
4892 Action Show the completion popup at the cursor position.
4893 \end_layout
4894 \begin_layout Description
4895 Syntax completion-popup
4896 \end_layout
4897 \begin_layout Description
4898 Origin sts, Feb 19 2008
4899 \end_layout
4900
4901 \begin_layout Subsection*
4902 LFUN_COMPLETION_COMPLETE
4903 \end_layout
4904 \begin_layout Description
4905 Action Try to complete the word or command at the cursor position.
4906 \end_layout
4907 \begin_layout Description
4908 Syntax complete
4909 \end_layout
4910 \begin_layout Description
4911 Origin sts, Feb 19 2008
4912 \end_layout
4913
4914 \begin_layout Subsection*
4915 LFUN_COMPLETION_CANCEL
4916 \end_layout
4917 \begin_layout Description
4918 Action Try to cancel completion, either the popup or the inline completion
4919 \end_layout
4920 \begin_layout Description
4921 Syntax completion-cancel
4922 \end_layout
4923 \begin_layout Description
4924 Origin sts, Sep 07 2008
4925 \end_layout
4926
4927 \begin_layout Subsection*
4928 LFUN_COMPLETION_ACCEPT
4929 \end_layout
4930 \begin_layout Description
4931 Action Accept suggested completion.
4932 \end_layout
4933 \begin_layout Description
4934 Syntax completion-accept
4935 \end_layout
4936 \begin_layout Description
4937 Origin sanda, Sep 08 2008
4938 \end_layout
4939
4940 \begin_layout Subsection*
4941 LFUN_BRANCH_ACTIVATE
4942 \end_layout
4943 \begin_layout Description
4944 Action Activate the branch
4945 \end_layout
4946 \begin_layout Description
4947 Syntax branch-activate <BRANCH>
4948 \end_layout
4949 \begin_layout Description
4950 Params <BRANCH>: The branch to activate
4951 \end_layout
4952 \begin_layout Description
4953 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
4954 \begin_inset Newline newline
4955 \end_inset
4956
4957 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
4958 \end_layout
4959 \begin_layout Description
4960 Origin rgh, 27 May 2008
4961 \end_layout
4962
4963 \begin_layout Subsection*
4964 LFUN_BRANCH_DEACTIVATE
4965 \end_layout
4966 \begin_layout Description
4967 Action De-activate the branch
4968 \end_layout
4969 \begin_layout Description
4970 Syntax branch-deactivate <BRANCH>
4971 \end_layout
4972 \begin_layout Description
4973 Params <BRANCH>: The branch to deactivate
4974 \end_layout
4975 \begin_layout Description
4976 Origin rgh, 27 May 2008
4977 \end_layout
4978
4979 \begin_layout Subsection*
4980 LFUN_LABEL_COPY_AS_REF
4981 \end_layout
4982 \begin_layout Description
4983 Action Copies the label at the cursor as a cross-reference to be pasted elsewhere.
4984 \end_layout
4985 \begin_layout Description
4986 Syntax copy-label-as-reference <LABEL>
4987 \end_layout
4988 \begin_layout Description
4989 Params <LABEL>: The label to copy (for multi-line math)
4990 \end_layout
4991 \begin_layout Description
4992 Origin sts, 16 Nov 2008
4993 \end_layout
4994
4995 \begin_layout Subsection*
4996 LFUN_LABEL_INSERT_AS_REF
4997 \end_layout
4998 \begin_layout Description
4999 Action Inserts the label as a cross-reference at the position of the cursor.
5000 \end_layout
5001 \begin_layout Description
5002 Syntax label-insert-as-reference
5003 \end_layout
5004 \begin_layout Description
5005 Origin vfr, 7 Apr 2009
5006 \end_layout
5007
5008 \begin_layout Subsection*
5009 LFUN_BUFFER_ZOOM_IN
5010 \end_layout
5011 \begin_layout Description
5012 Action Increases the zoom of the screen fonts.
5013 \end_layout
5014 \begin_layout Description
5015 Syntax buffer-zoom-in [<ZOOM>]
5016 \end_layout
5017 \begin_layout Description
5018 Params <ZOOM>: The zoom in %, the default is 20.
5019 \end_layout
5020 \begin_layout Description
5021 Origin vfr, 30 Mar 2009
5022 \end_layout
5023
5024 \begin_layout Subsection*
5025 LFUN_BUFFER_ZOOM_OUT
5026 \end_layout
5027 \begin_layout Description
5028 Action Decreases the zoom of the screen fonts.
5029 \end_layout
5030 \begin_layout Description
5031 Syntax buffer-zoom-out [<ZOOM>]
5032 \end_layout
5033 \begin_layout Description
5034 Params <ZOOM>: The zoom in %, the default is 20.
5035 \end_layout
5036 \begin_layout Description
5037 Origin vfr, 30 Mar 2009
5038 \end_layout
5039
5040 \begin_layout Subsection*
5041 LFUN_SECTION_SELECT
5042 \end_layout
5043 \begin_layout Description
5044 Action Selects the whole section.
5045 \end_layout
5046 \begin_layout Description
5047 Notion The cursor should be in a section heading before calling this lfun.
5048 \end_layout
5049 \begin_layout Description
5050 Syntax section-select
5051 \end_layout
5052 \begin_layout Description
5053 Origin vfr, 05 May 2009
5054 \end_layout
5055
5056 \end_body
5057 \end_document