]> git.lyx.org Git - lyx.git/blob - lib/doc/LFUNs.lyx
an example for the sweave module, prepared by Gregor Gorjanc
[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-05-17
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 from the active clipboard.
1535 \end_layout
1536 \begin_layout Description
1537 Syntax paste [<TYPE>]
1538 \end_layout
1539 \begin_layout Description
1540 Params <TYPE>: emf|pdf|png|jpeg|linkback|wmf
1541 \end_layout
1542
1543 \begin_layout Subsection*
1544 LFUN_CLIPBOARD_PASTE
1545 \end_layout
1546 \begin_layout Description
1547 Action Pastes text from the active clipboard.
1548 \end_layout
1549 \begin_layout Description
1550 Syntax clipboard-paste [<ARG>]
1551 \end_layout
1552 \begin_layout Description
1553 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1554 \end_layout
1555 \begin_layout Description
1556 Origin baum, 10 Jul 2006
1557 \end_layout
1558
1559 \begin_layout Subsection*
1560 LFUN_PRIMARY_SELECTION_PASTE
1561 \end_layout
1562 \begin_layout Description
1563 Action Pastes the currently text selected text.
1564 \end_layout
1565 \begin_layout Description
1566 Notion Primary selection mechanism is linux-only thing.
1567 \end_layout
1568 \begin_layout Description
1569 Syntax primary-selection-paste [<ARG>]
1570 \end_layout
1571 \begin_layout Description
1572 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1573 \end_layout
1574
1575 \begin_layout Subsection*
1576 LFUN_SELECTION_PASTE
1577 \end_layout
1578 \begin_layout Description
1579 Action Pastes the text in permanent selection.
1580 \end_layout
1581 \begin_layout Description
1582 Syntax selection-paste
1583 \end_layout
1584
1585 \begin_layout Subsection*
1586 LFUN_UNDO
1587 \end_layout
1588 \begin_layout Description
1589 Action Undoes the last edit.
1590 \end_layout
1591 \begin_layout Description
1592 Syntax undo
1593 \end_layout
1594
1595 \begin_layout Subsection*
1596 LFUN_REDO
1597 \end_layout
1598 \begin_layout Description
1599 Action Redoes the last thing undone.
1600 \end_layout
1601 \begin_layout Description
1602 Syntax redo
1603 \end_layout
1604
1605 \begin_layout Subsection*
1606 LFUN_REPEAT
1607 \end_layout
1608 \begin_layout Description
1609 Action Repeat the given command.
1610 \end_layout
1611 \begin_layout Description
1612 Syntax repeat <COUNT> <LFUN-COMMAND>
1613 \end_layout
1614 \begin_layout Description
1615 Origin Andre, 27 Oct 2003
1616 \end_layout
1617
1618 \begin_layout Subsection*
1619 LFUN_CHARS_TRANSPOSE
1620 \end_layout
1621 \begin_layout Description
1622 Action Transposes the character at the cursor with the one before it.
1623 \end_layout
1624 \begin_layout Description
1625 Syntax chars-transpose
1626 \end_layout
1627 \begin_layout Description
1628 Origin Lgb, 25 Apr 2001
1629 \end_layout
1630
1631 \begin_layout Subsection*
1632 LFUN_DEPTH_DECREMENT
1633 \end_layout
1634 \begin_layout Description
1635 Action Decrease the nesting depth of the (selected) paragraph(s) inside lists.
1636 \end_layout
1637 \begin_layout Description
1638 Syntax depth-decrement
1639 \end_layout
1640
1641 \begin_layout Subsection*
1642 LFUN_DEPTH_INCREMENT
1643 \end_layout
1644 \begin_layout Description
1645 Action Increase the nesting depth of the (selected) paragraph(s) inside lists.
1646 \end_layout
1647 \begin_layout Description
1648 Syntax depth-increment
1649 \end_layout
1650
1651 \begin_layout Subsection*
1652 LFUN_FONT_BOLD
1653 \end_layout
1654 \begin_layout Description
1655 Action Toggles the bold font (selection-wise) using mathbf in math.
1656 \end_layout
1657 \begin_layout Description
1658 Syntax font-bold
1659 \end_layout
1660
1661 \begin_layout Subsection*
1662 LFUN_FONT_BOLDSYMBOL
1663 \end_layout
1664 \begin_layout Description
1665 Action Toggles the bold font (selection-wise) using boldsymbol in math.
1666 \end_layout
1667 \begin_layout Description
1668 Syntax font-boldsymbol
1669 \end_layout
1670
1671 \begin_layout Subsection*
1672 LFUN_FONT_TYPEWRITER
1673 \end_layout
1674 \begin_layout Description
1675 Action Toggles the typewriter family font (selection-wise).
1676 \end_layout
1677 \begin_layout Description
1678 Syntax font-typewriter
1679 \end_layout
1680
1681 \begin_layout Subsection*
1682 LFUN_FONT_UNDERLINE
1683 \end_layout
1684 \begin_layout Description
1685 Action Toggles underline in the font (selection-wise).
1686 \end_layout
1687 \begin_layout Description
1688 Syntax font-underline
1689 \end_layout
1690
1691 \begin_layout Subsection*
1692 LFUN_FONT_UULINE
1693 \end_layout
1694 \begin_layout Description
1695 Action Toggles double underline in the font (selection-wise).
1696 \end_layout
1697 \begin_layout Description
1698 Syntax font-underunderline
1699 \end_layout
1700 \begin_layout Description
1701 Origin sanda, 5 May 2009
1702 \end_layout
1703
1704 \begin_layout Subsection*
1705 LFUN_FONT_UWAVE
1706 \end_layout
1707 \begin_layout Description
1708 Action Toggles wavy underline in the font (selection-wise).
1709 \end_layout
1710 \begin_layout Description
1711 Syntax font-underwave
1712 \end_layout
1713 \begin_layout Description
1714 Origin sanda, 5 May 2009
1715 \end_layout
1716
1717 \begin_layout Subsection*
1718 LFUN_FONT_STRIKEOUT
1719 \end_layout
1720 \begin_layout Description
1721 Action Toggles strikeout (strike-through) in the font (selection-wise).
1722 \end_layout
1723 \begin_layout Description
1724 Syntax font-strikeout
1725 \end_layout
1726 \begin_layout Description
1727 Origin sanda, 3 May 2009
1728 \end_layout
1729
1730 \begin_layout Subsection*
1731 LFUN_FONT_EMPH
1732 \end_layout
1733 \begin_layout Description
1734 Action Toggles the emphasis font style (selection-wise).
1735 \end_layout
1736 \begin_layout Description
1737 Syntax font-emph
1738 \end_layout
1739
1740 \begin_layout Subsection*
1741 LFUN_FONT_NOUN
1742 \end_layout
1743 \begin_layout Description
1744 Action Toggles Noun text style font (selection-wise).
1745 \end_layout
1746 \begin_layout Description
1747 Syntax font-noun
1748 \end_layout
1749
1750 \begin_layout Subsection*
1751 LFUN_FONT_ROMAN
1752 \end_layout
1753 \begin_layout Description
1754 Action Toggles Roman family font (selection-wise).
1755 \end_layout
1756 \begin_layout Description
1757 Syntax font-roman
1758 \end_layout
1759
1760 \begin_layout Subsection*
1761 LFUN_FONT_SANS
1762 \end_layout
1763 \begin_layout Description
1764 Action Toggles Sans Serif family font (selection-wise).
1765 \end_layout
1766 \begin_layout Description
1767 Syntax font-sans
1768 \end_layout
1769
1770 \begin_layout Subsection*
1771 LFUN_FONT_FRAK
1772 \end_layout
1773 \begin_layout Description
1774 Action Toggles Fraktur family font (math-mode, selection-wise).
1775 \end_layout
1776 \begin_layout Description
1777 Syntax font-frak
1778 \end_layout
1779 \begin_layout Description
1780 Origin vermeer, 10 Jan 2002
1781 \end_layout
1782
1783 \begin_layout Subsection*
1784 LFUN_FONT_ITAL
1785 \end_layout
1786 \begin_layout Description
1787 Action Toggles Italics font shape (math-mode, selection-wise).
1788 \end_layout
1789 \begin_layout Description
1790 Syntax font-ital
1791 \end_layout
1792 \begin_layout Description
1793 Origin vermeer, 10 Jan 2002
1794 \end_layout
1795
1796 \begin_layout Subsection*
1797 LFUN_FONT_DEFAULT
1798 \end_layout
1799 \begin_layout Description
1800 Action Reverts the settings of the font to the default values (selection-wise).
1801 \end_layout
1802 \begin_layout Description
1803 Syntax font-default
1804 \end_layout
1805
1806 \begin_layout Subsection*
1807 LFUN_FONT_SIZE
1808 \end_layout
1809 \begin_layout Description
1810 Action Sets font size according to lyx format string.
1811 \end_layout
1812 \begin_layout Description
1813 Syntax font-size <SIZE>
1814 \end_layout
1815 \begin_layout Description
1816 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
1817 \begin_inset Newline newline
1818 \end_inset
1819
1820 largest|huge|giant|increase|decrease|default
1821 \end_layout
1822
1823 \begin_layout Subsection*
1824 LFUN_TEXTSTYLE_APPLY
1825 \end_layout
1826 \begin_layout Description
1827 Action Toggle user-defined (=last-time used) text style.
1828 \end_layout
1829 \begin_layout Description
1830 Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically trigerred when using Text Style dialog.
1831 \end_layout
1832 \begin_layout Description
1833 Syntax textstyle-apply
1834 \end_layout
1835 \begin_layout Description
1836 Origin leeming, 12 Mar 2003
1837 \end_layout
1838
1839 \begin_layout Subsection*
1840 LFUN_TEXTSTYLE_UPDATE
1841 \end_layout
1842 \begin_layout Description
1843 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APPLY.
1844 \end_layout
1845 \begin_layout Description
1846 Syntax textstyle-update <FONT_INFO>
1847 \end_layout
1848 \begin_layout Description
1849 Params <FONT_INFO>: specifies font atributes, e.g. family, series, shape, size, emph, noun, underbar, number, color, language, toggleall.
1850 \begin_inset Newline newline
1851 \end_inset
1852
1853 Use lyx -dbg action for exact syntax of text-style dialog parameters.
1854 \end_layout
1855 \begin_layout Description
1856 Origin leeming, 12 Mar 2003
1857 \end_layout
1858
1859 \begin_layout Subsection*
1860 LFUN_SCREEN_FONT_UPDATE
1861 \end_layout
1862 \begin_layout Description
1863 Action Update fonts and its metrics.
1864 \end_layout
1865 \begin_layout Description
1866 Notion Automatically called after zoom, dpi, font names, or norm change.
1867 \end_layout
1868 \begin_layout Description
1869 Syntax screen-font-update
1870 \end_layout
1871 \begin_layout Description
1872 Origin ARRae, 13 Aug 2000
1873 \end_layout
1874
1875 \begin_layout Subsection*
1876 LFUN_FONT_STATE
1877 \end_layout
1878 \begin_layout Description
1879 Action Returns the info about the current font.
1880 \end_layout
1881 \begin_layout Description
1882 Syntax font-state
1883 \end_layout
1884
1885 \begin_layout Subsection*
1886 LFUN_CITATION_INSERT
1887 \end_layout
1888 \begin_layout Description
1889 Action Inserts citation from loaded citation database.
1890 \end_layout
1891 \begin_layout Description
1892 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
1893 \end_layout
1894 \begin_layout Description
1895 Params <KEY>: Citation (shortcut listed in available citations).
1896 \begin_inset Newline newline
1897 \end_inset
1898
1899 <TEXT_BEFORE>: text which should appear before citation.
1900 \end_layout
1901 \begin_layout Description
1902 Origin AAS, 97-02-23
1903 \end_layout
1904
1905 \begin_layout Subsection*
1906 LFUN_BIBTEX_DATABASE_ADD
1907 \end_layout
1908 \begin_layout Description
1909 Action Adds database, which will be used for bibtex citations.
1910 \end_layout
1911 \begin_layout Description
1912 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1913 \end_layout
1914 \begin_layout Description
1915 Syntax bibtex-database-add <DATABASE-NAME>
1916 \end_layout
1917 \begin_layout Description
1918 Origin Ale, 30 May 1997
1919 \end_layout
1920
1921 \begin_layout Subsection*
1922 LFUN_BIBTEX_DATABASE_DEL
1923 \end_layout
1924 \begin_layout Description
1925 Action Adds database, which will be used for bibtex citations.
1926 \end_layout
1927 \begin_layout Description
1928 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1929 \end_layout
1930 \begin_layout Description
1931 Syntax bibtex-database-del <DATABASE-NAME>
1932 \end_layout
1933 \begin_layout Description
1934 Origin Ale, 30 May 1997
1935 \end_layout
1936
1937 \begin_layout Subsection*
1938 LFUN_LAYOUT
1939 \end_layout
1940 \begin_layout Description
1941 Action Sets the layout (that is, environment) for the current paragraph.
1942 \end_layout
1943 \begin_layout Description
1944 Syntax layout <LAYOUT>
1945 \end_layout
1946 \begin_layout Description
1947 Params <LAYOUT>: the layout to use
1948 \end_layout
1949
1950 \begin_layout Subsection*
1951 LFUN_LAYOUT_PARAGRAPH
1952 \end_layout
1953 \begin_layout Description
1954 Action Launches the paragraph settings dialog.
1955 \end_layout
1956 \begin_layout Description
1957 Syntax layout-paragraph
1958 \end_layout
1959
1960 \begin_layout Subsection*
1961 LFUN_LAYOUT_TABULAR
1962 \end_layout
1963 \begin_layout Description
1964 Action Launches the tabular settings dialog.
1965 \end_layout
1966 \begin_layout Description
1967 Syntax layout-tabular
1968 \end_layout
1969 \begin_layout Description
1970 Origin Jug, 31 Jul 2000
1971 \end_layout
1972
1973 \begin_layout Subsection*
1974 LFUN_DROP_LAYOUTS_CHOICE
1975 \end_layout
1976 \begin_layout Description
1977 Action Displays list of layout choices.
1978 \end_layout
1979 \begin_layout Description
1980 Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox allowing for choice of layout.
1981 \end_layout
1982 \begin_layout Description
1983 Syntax drop-layouts-choice
1984 \end_layout
1985
1986 \begin_layout Subsection*
1987 LFUN_LAYOUT_MODULES_CLEAR
1988 \end_layout
1989 \begin_layout Description
1990 Action Clears the module list.
1991 \end_layout
1992 \begin_layout Description
1993 Notion Clears the list of included modules for the current buffer.
1994 \end_layout
1995 \begin_layout Description
1996 Syntax layout-modules-clear
1997 \end_layout
1998 \begin_layout Description
1999 Origin rgh, 25 August 2007
2000 \end_layout
2001
2002 \begin_layout Subsection*
2003 LFUN_LAYOUT_MODULE_ADD
2004 \end_layout
2005 \begin_layout Description
2006 Action Adds a module.
2007 \end_layout
2008 \begin_layout Description
2009 Notion Adds a module to the list of included modules for the current buffer.
2010 \end_layout
2011 \begin_layout Description
2012 Syntax layout-module-add <MODULE>
2013 \end_layout
2014 \begin_layout Description
2015 Params <MODULE>: the module to be added
2016 \end_layout
2017 \begin_layout Description
2018 Origin rgh, 25 August 2007
2019 \end_layout
2020
2021 \begin_layout Subsection*
2022 LFUN_LAYOUT_RELOAD
2023 \end_layout
2024 \begin_layout Description
2025 Action Reloads layout information.
2026 \end_layout
2027 \begin_layout Description
2028 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.
2029 \end_layout
2030 \begin_layout Description
2031 Syntax layout-reload
2032 \end_layout
2033 \begin_layout Description
2034 Origin rgh, 3 September 2007
2035 \end_layout
2036
2037 \begin_layout Subsection*
2038 LFUN_TEXTCLASS_APPLY
2039 \end_layout
2040 \begin_layout Description
2041 Action Sets the text class for the current buffer.
2042 \end_layout
2043 \begin_layout Description
2044 Syntax textclass-apply <TEXTCLASS>
2045 \end_layout
2046 \begin_layout Description
2047 Params <TEXTCLASS>: the textclass to set. Note that this must be the filename, minus the ".layout" extension.
2048 \end_layout
2049
2050 \begin_layout Subsection*
2051 LFUN_TEXTCLASS_LOAD
2052 \end_layout
2053 \begin_layout Description
2054 Action Loads information for a textclass from disk.
2055 \end_layout
2056 \begin_layout Description
2057 Syntax textclass-load <TEXTCLASS>
2058 \end_layout
2059 \begin_layout Description
2060 Params <TEXTCLASS>: the textclass to load. Note that this must be the filename, minus the ".layout" extension.
2061 \end_layout
2062
2063 \begin_layout Subsection*
2064 LFUN_MARK_OFF
2065 \end_layout
2066 \begin_layout Description
2067 Action Disable selecting of text-region.
2068 \end_layout
2069 \begin_layout Description
2070 Syntax mark-off
2071 \end_layout
2072
2073 \begin_layout Subsection*
2074 LFUN_MARK_ON
2075 \end_layout
2076 \begin_layout Description
2077 Action Enable selecting of text-region.
2078 \end_layout
2079 \begin_layout Description
2080 Notion After enabling you can simply move arrow keys to get selected region.
2081 \end_layout
2082 \begin_layout Description
2083 Syntax mark-on
2084 \end_layout
2085
2086 \begin_layout Subsection*
2087 LFUN_MARK_TOGGLE
2088 \end_layout
2089 \begin_layout Description
2090 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
2091 \end_layout
2092 \begin_layout Description
2093 Syntax mark-toggle
2094 \end_layout
2095 \begin_layout Description
2096 Origin Andre, May 5 2006
2097 \end_layout
2098
2099 \begin_layout Subsection*
2100 LFUN_MATH_DELIM
2101 \end_layout
2102 \begin_layout Description
2103 Action Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
2104 \end_layout
2105 \begin_layout Description
2106 Syntax math-delim [<LEFT>] [<RIGHT>]
2107 \end_layout
2108 \begin_layout Description
2109 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.
2110 \end_layout
2111 \begin_layout Description
2112 Sample math-delim { rangle
2113 \end_layout
2114 \begin_layout Description
2115 Origin Alejandro, 18 Jun 1996
2116 \end_layout
2117
2118 \begin_layout Subsection*
2119 LFUN_MATH_BIGDELIM
2120 \end_layout
2121 \begin_layout Description
2122 Action Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
2123 \end_layout
2124 \begin_layout Description
2125 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
2126 \end_layout
2127 \begin_layout Description
2128 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
2129 \begin_inset Newline newline
2130 \end_inset
2131
2132 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
2133 \end_layout
2134 \begin_layout Description
2135 Sample math-bigdelim "Bigl" "
2136 \backslash
2137 Downarrow" "Bigr" "
2138 \backslash
2139 }"
2140 \end_layout
2141 \begin_layout Description
2142 Origin Enrico & Georg, 7 May 2006
2143 \end_layout
2144
2145 \begin_layout Subsection*
2146 LFUN_MATH_DISPLAY
2147 \end_layout
2148 \begin_layout Description
2149 Action Creates a new displayed equation in text mode. Toggles inlined/display formula in math mode.
2150 \end_layout
2151 \begin_layout Description
2152 Syntax math-display [<ARG>]
2153 \end_layout
2154 \begin_layout Description
2155 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating new equation from the text mode.
2156 \end_layout
2157 \begin_layout Description
2158 Origin Alejandro, 18 Jun 1996
2159 \end_layout
2160
2161 \begin_layout Subsection*
2162 LFUN_MATH_INSERT
2163 \end_layout
2164 \begin_layout Description
2165 Action Inserts math objects and symbols.
2166 \end_layout
2167 \begin_layout Description
2168 Syntax math-insert <ARG>
2169 \end_layout
2170 \begin_layout Description
2171 Params <ARG>: Symbol or LaTeX code to be inserted.
2172 \end_layout
2173
2174 \begin_layout Subsection*
2175 LFUN_MATH_SUBSCRIPT
2176 \end_layout
2177 \begin_layout Description
2178 Action Enters subscript expression in math expression.
2179 \end_layout
2180 \begin_layout Description
2181 Syntax math-subscript
2182 \end_layout
2183 \begin_layout Description
2184 Origin vermeer, 12 Dec 2001
2185 \end_layout
2186
2187 \begin_layout Subsection*
2188 LFUN_MATH_SUPERSCRIPT
2189 \end_layout
2190 \begin_layout Description
2191 Action Enters subscript expression in math expression.
2192 \end_layout
2193 \begin_layout Description
2194 Syntax math-superscript
2195 \end_layout
2196 \begin_layout Description
2197 Origin vermeer, 12 Dec 2001
2198 \end_layout
2199
2200 \begin_layout Subsection*
2201 LFUN_MATH_LIMITS
2202 \end_layout
2203 \begin_layout Description
2204 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.
2205 \end_layout
2206 \begin_layout Description
2207 Notion Put the cursor before the symbol with the limits and then invoke math-limits.
2208 \end_layout
2209 \begin_layout Description
2210 Syntax math-limits [<STATE>]
2211 \end_layout
2212 \begin_layout Description
2213 Params <STATE>: limits|nolimits
2214 \end_layout
2215
2216 \begin_layout Subsection*
2217 LFUN_MATH_MACRO
2218 \end_layout
2219 \begin_layout Description
2220 Action Inserts a math macro definition at the cursor position in the text.
2221 \end_layout
2222 \begin_layout Description
2223 Syntax math-macro <NAME> [<NARGS>] [def]
2224 \end_layout
2225 \begin_layout Description
2226 Params <NAME>: The name of the macro, e.g. "mymacro".
2227 \begin_inset Newline newline
2228 \end_inset
2229
2230 <NARGS>: The number of parameters of the macro. Default is 0. "def": Has no effect anymore, just for compatibility with former LyX versions.
2231 \end_layout
2232 \begin_layout Description
2233 Origin ale, 10 May 1997;  sts, 21 Dec 2007
2234 \end_layout
2235
2236 \begin_layout Subsection*
2237 LFUN_MATH_MUTATE
2238 \end_layout
2239 \begin_layout Description
2240 Action Mutates the type of math inset to the newly selected one.
2241 \end_layout
2242 \begin_layout Description
2243 Syntax math-mutate <TYPE>
2244 \end_layout
2245 \begin_layout Description
2246 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat| multline|gather|flalign
2247 \end_layout
2248 \begin_layout Description
2249 Origin Andre, 23 May 2001
2250 \end_layout
2251
2252 \begin_layout Subsection*
2253 LFUN_MATH_SPACE
2254 \end_layout
2255 \begin_layout Description
2256 Action Inserts space into math expression.
2257 \end_layout
2258 \begin_layout Description
2259 Notion Use spacebar after entering this space to change type of space.
2260 \end_layout
2261 \begin_layout Description
2262 Syntax math-space [<TYPE>] [<LEN>]
2263 \end_layout
2264 \begin_layout Description
2265 Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
2266 \begin_inset Newline newline
2267 \end_inset
2268
2269 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
2270 \begin_inset Newline newline
2271 \end_inset
2272
2273 custom space: hspace
2274 \begin_inset Newline newline
2275 \end_inset
2276
2277 "," used by default.
2278 \begin_inset Newline newline
2279 \end_inset
2280
2281 Note that ! is equivalent to negthinspace, , = thinspace, : = medspace, and ; = thickspace.
2282 \begin_inset Newline newline
2283 \end_inset
2284
2285 <LEN>: length for custom spaces (hspace)
2286 \end_layout
2287 \begin_layout Description
2288 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
2289 \end_layout
2290
2291 \begin_layout Subsection*
2292 LFUN_MATH_MATRIX
2293 \end_layout
2294 \begin_layout Description
2295 Action Inserts a matrix.
2296 \end_layout
2297 \begin_layout Description
2298 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
2299 \end_layout
2300 \begin_layout Description
2301 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).
2302 \end_layout
2303 \begin_layout Description
2304 Sample math-matrix 3 3 bccc
2305 \end_layout
2306
2307 \begin_layout Subsection*
2308 LFUN_MATH_MODE
2309 \end_layout
2310 \begin_layout Description
2311 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.
2312 \end_layout
2313 \begin_layout Description
2314 Notion If there is some selected text, it puts the text inside created math box.
2315 \end_layout
2316 \begin_layout Description
2317 Syntax math-mode [<ARG>]
2318 \end_layout
2319 \begin_layout Description
2320 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT .
2321 \end_layout
2322 \begin_layout Description
2323 Origin Alejandro, 4 Jun 1996
2324 \end_layout
2325
2326 \begin_layout Subsection*
2327 LFUN_REGEXP_MODE
2328 \end_layout
2329 \begin_layout Description
2330 Action Enters regexp mode (i.e., puts regexp insets on the current cursor position). Used by the advanced search dialog.
2331 \end_layout
2332 \begin_layout Description
2333 Notion If there is any selected text, then it is moved inside the created regexp inset.
2334 \end_layout
2335 \begin_layout Description
2336 Syntax regexp-mode [<ARG>]
2337 \end_layout
2338 \begin_layout Description
2339 Params <ARG>: eventual argument (regular expression).
2340 \end_layout
2341 \begin_layout Description
2342 Origin Tommaso, 4 Oct 2008
2343 \end_layout
2344
2345 \begin_layout Subsection*
2346 LFUN_MATH_NUMBER_LINE_TOGGLE
2347 \end_layout
2348 \begin_layout Description
2349 Action Toggles numbering of the current formula line.
2350 \end_layout
2351 \begin_layout Description
2352 Notion Must be in display formula mode.
2353 \end_layout
2354 \begin_layout Description
2355 Syntax math-number-line-toggle
2356 \end_layout
2357 \begin_layout Description
2358 Origin Alejandro, 18 Jun 1996
2359 \end_layout
2360
2361 \begin_layout Subsection*
2362 LFUN_MATH_NUMBER_TOGGLE
2363 \end_layout
2364 \begin_layout Description
2365 Action Toggles numbering/labeling of the current formula.
2366 \end_layout
2367 \begin_layout Description
2368 Notion Must be in display formula mode.
2369 \end_layout
2370 \begin_layout Description
2371 Syntax math-number-toggle
2372 \end_layout
2373 \begin_layout Description
2374 Origin Alejandro, 4 Jun 1996
2375 \end_layout
2376
2377 \begin_layout Subsection*
2378 LFUN_MATH_EXTERN
2379 \end_layout
2380 \begin_layout Description
2381 Action Calls external program and passes the current expression/equation as an argument for the calculation in the format appropriate to the given language.
2382 \end_layout
2383 \begin_layout Description
2384 Notion Selection can be used to determine the input for the external program.
2385 \end_layout
2386 \begin_layout Description
2387 Syntax math-extern <LANG> [<COMMAND>]
2388 \end_layout
2389 \begin_layout Description
2390 Params <LANG>: octave|maxima|maple|mathematica|script
2391 \begin_inset Newline newline
2392 \end_inset
2393
2394 where "script" stands fot the external script (normalized expression will be passed)
2395 \end_layout
2396 \begin_layout Description
2397 Sample math-extern maple simplify
2398 \end_layout
2399 \begin_layout Description
2400 Origin Andre, 24 Apr 2001
2401 \end_layout
2402
2403 \begin_layout Subsection*
2404 LFUN_MATH_SIZE
2405 \end_layout
2406 \begin_layout Description
2407 Action Changes arbitrarily the size used by math fonts inside a context.
2408 \end_layout
2409 \begin_layout Description
2410 Notion Provides an interface to the LaTeX math mode font size commands.
2411 \end_layout
2412 \begin_layout Description
2413 Syntax math-size <STYLE>
2414 \end_layout
2415 \begin_layout Description
2416 Params <STYLE>: 
2417 \backslash
2418 displaystyle|
2419 \backslash
2420 textstyle|
2421 \backslash
2422 scriptstyle|
2423 \backslash
2424 scriptscriptstyle
2425 \end_layout
2426 \begin_layout Description
2427 Origin Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
2428 \end_layout
2429
2430 \begin_layout Subsection*
2431 LFUN_MATH_FONT_STYLE
2432 \end_layout
2433 \begin_layout Description
2434 Action Changes the text style used in math.
2435 \end_layout
2436 \begin_layout Description
2437 Syntax math-font-style <STYLE>
2438 \end_layout
2439 \begin_layout Description
2440 Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf |textnormal|textrm|textsf|texttt|textbf|textmd|textit |textsc|textsl|textup
2441 \end_layout
2442 \begin_layout Description
2443 Origin vfr, 9 jan 2009
2444 \end_layout
2445
2446 \begin_layout Subsection*
2447 LFUN_MATH_MACRO_UNFOLD
2448 \end_layout
2449 \begin_layout Description
2450 Action Unfold a Math Macro.
2451 \end_layout
2452 \begin_layout Description
2453 Notion Unfold the Math Macro the cursor is in, i.e. display it as 
2454 \backslash
2455 foo.
2456 \end_layout
2457 \begin_layout Description
2458 Syntax math-macro-unfold
2459 \end_layout
2460 \begin_layout Description
2461 Origin sts, 06 January 2008
2462 \end_layout
2463
2464 \begin_layout Subsection*
2465 LFUN_MATH_MACRO_FOLD
2466 \end_layout
2467 \begin_layout Description
2468 Action Fold a Math Macro.
2469 \end_layout
2470 \begin_layout Description
2471 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e. displayed as 
2472 \backslash
2473 foo before.
2474 \end_layout
2475 \begin_layout Description
2476 Syntax math-macro-fold
2477 \end_layout
2478 \begin_layout Description
2479 Origin sts, 06 January 2008
2480 \end_layout
2481
2482 \begin_layout Subsection*
2483 LFUN_MATH_MACRO_ADD_PARAM
2484 \end_layout
2485 \begin_layout Description
2486 Action Add a parameter.
2487 \end_layout
2488 \begin_layout Description
2489 Notion Add a parameter to a Math Macro.
2490 \end_layout
2491 \begin_layout Description
2492 Syntax math-macro-add-param <NUM>
2493 \end_layout
2494 \begin_layout Description
2495 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.
2496 \end_layout
2497 \begin_layout Description
2498 Origin sts, 06 January 2008
2499 \end_layout
2500
2501 \begin_layout Subsection*
2502 LFUN_MATH_MACRO_REMOVE_PARAM
2503 \end_layout
2504 \begin_layout Description
2505 Action Remove the last parameter.
2506 \end_layout
2507 \begin_layout Description
2508 Notion Remove the last parameter of a Math Macro and remove its value in all instances of the macro in the buffer.
2509 \end_layout
2510 \begin_layout Description
2511 Syntax math-macro-remove-param <NUM>
2512 \end_layout
2513 \begin_layout Description
2514 Params <NUM>: The number of the parameter to be deleted (1 for the first), defaults to the last one.
2515 \end_layout
2516 \begin_layout Description
2517 Origin sts, 06 January 2008
2518 \end_layout
2519
2520 \begin_layout Subsection*
2521 LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
2522 \end_layout
2523 \begin_layout Description
2524 Action Append a greedy parameter.
2525 \end_layout
2526 \begin_layout Description
2527 Notion Append a greedy parameter to a Math Macro which eats the following mathed cell in every instance of the macro in the buffer.
2528 \end_layout
2529 \begin_layout Description
2530 Syntax math-macro-append-greedy-param
2531 \end_layout
2532 \begin_layout Description
2533 Origin sts, 06 January 2008
2534 \end_layout
2535
2536 \begin_layout Subsection*
2537 LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
2538 \end_layout
2539 \begin_layout Description
2540 Action Remove a greedy parameter.
2541 \end_layout
2542 \begin_layout Description
2543 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.
2544 \end_layout
2545 \begin_layout Description
2546 Syntax math-macro-remove-greedy-param
2547 \end_layout
2548 \begin_layout Description
2549 Origin sts, 06 January 2008
2550 \end_layout
2551
2552 \begin_layout Subsection*
2553 LFUN_MATH_MACRO_MAKE_OPTIONAL
2554 \end_layout
2555 \begin_layout Description
2556 Action Make a parameter optional.
2557 \end_layout
2558 \begin_layout Description
2559 Notion Turn the first non-optional parameter of a Math Macro into an optional parameter with a default value.
2560 \end_layout
2561 \begin_layout Description
2562 Syntax math-macro-make-optional
2563 \end_layout
2564 \begin_layout Description
2565 Origin sts, 06 January 2008
2566 \end_layout
2567
2568 \begin_layout Subsection*
2569 LFUN_MATH_MACRO_MAKE_NONOPTIONAL
2570 \end_layout
2571 \begin_layout Description
2572 Action Make a parameter non-optional.
2573 \end_layout
2574 \begin_layout Description
2575 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.
2576 \end_layout
2577 \begin_layout Description
2578 Syntax math-macro-make-nonoptional
2579 \end_layout
2580 \begin_layout Description
2581 Origin sts, 06 January 2008
2582 \end_layout
2583
2584 \begin_layout Subsection*
2585 LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
2586 \end_layout
2587 \begin_layout Description
2588 Action Add an optional parameter.
2589 \end_layout
2590 \begin_layout Description
2591 Notion Insert an optional parameter just behind the already existing optional parameters.
2592 \end_layout
2593 \begin_layout Description
2594 Syntax math-macro-add-optional-param
2595 \end_layout
2596 \begin_layout Description
2597 Origin sts, 06 January 2008
2598 \end_layout
2599
2600 \begin_layout Subsection*
2601 LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
2602 \end_layout
2603 \begin_layout Description
2604 Action Remove the last optional parameter.
2605 \end_layout
2606 \begin_layout Description
2607 Notion Remove the last optional parameter of a Math Macro and remove it in all the instances of the macro in the buffer.
2608 \end_layout
2609 \begin_layout Description
2610 Syntax math-macro-remove-optional-param
2611 \end_layout
2612 \begin_layout Description
2613 Origin sts, 06 January 2008
2614 \end_layout
2615
2616 \begin_layout Subsection*
2617 LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
2618 \end_layout
2619 \begin_layout Description
2620 Action Add a greedy optional parameter.
2621 \end_layout
2622 \begin_layout Description
2623 Notion Add a greedy optional parameter which eats the value from the following cells in mathed which are in the [value] format.
2624 \end_layout
2625 \begin_layout Description
2626 Syntax math-macro-add-greedy-optional-param
2627 \end_layout
2628 \begin_layout Description
2629 Origin sts, 06 January 2008
2630 \end_layout
2631
2632 \begin_layout Subsection*
2633 LFUN_IN_MATHMACROTEMPLATE
2634 \end_layout
2635 \begin_layout Description
2636 Action Only active in Math Macro definition.
2637 \end_layout
2638 \begin_layout Description
2639 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.
2640 \end_layout
2641 \begin_layout Description
2642 Syntax in-mathmacrotemplate
2643 \end_layout
2644 \begin_layout Description
2645 Origin sts, 06 January 2008
2646 \end_layout
2647
2648 \begin_layout Subsection*
2649 LFUN_PARAGRAPH_MOVE_DOWN
2650 \end_layout
2651 \begin_layout Description
2652 Action Moves the current paragraph downwards in the document.
2653 \end_layout
2654 \begin_layout Description
2655 Syntax paragraph-move-down
2656 \end_layout
2657 \begin_layout Description
2658 Origin Edwin, 8 Apr 2006
2659 \end_layout
2660
2661 \begin_layout Subsection*
2662 LFUN_PARAGRAPH_MOVE_UP
2663 \end_layout
2664 \begin_layout Description
2665 Action Moves the current paragraph upwards in the document.
2666 \end_layout
2667 \begin_layout Description
2668 Syntax paragraph-move-up
2669 \end_layout
2670 \begin_layout Description
2671 Origin Edwin, 8 Apr 2006
2672 \end_layout
2673
2674 \begin_layout Subsection*
2675 LFUN_PARAGRAPH_UP
2676 \end_layout
2677 \begin_layout Description
2678 Action Move the cursor to the next paragraph (or begining of the current one) in upward direction.
2679 \end_layout
2680 \begin_layout Description
2681 Syntax paragraph-up
2682 \end_layout
2683 \begin_layout Description
2684 Origin Asger, 1 Oct 1996
2685 \end_layout
2686
2687 \begin_layout Subsection*
2688 LFUN_PARAGRAPH_UP_SELECT
2689 \end_layout
2690 \begin_layout Description
2691 Action Move the cursor and select the text to the next paragraph (or begining of the current one) in upward direction.
2692 \end_layout
2693 \begin_layout Description
2694 Syntax paragraph-up-select
2695 \end_layout
2696 \begin_layout Description
2697 Origin Asger, 1 Oct 1996
2698 \end_layout
2699
2700 \begin_layout Subsection*
2701 LFUN_PARAGRAPH_DOWN
2702 \end_layout
2703 \begin_layout Description
2704 Action Move the cursor to the next paragraph (or begining of the current one) in downward direction.
2705 \end_layout
2706 \begin_layout Description
2707 Syntax paragraph-down
2708 \end_layout
2709 \begin_layout Description
2710 Origin Asger, 1 Oct 1996
2711 \end_layout
2712
2713 \begin_layout Subsection*
2714 LFUN_PARAGRAPH_DOWN_SELECT
2715 \end_layout
2716 \begin_layout Description
2717 Action Move the cursor and select the text to the next paragraph (or begining of the current one) in downward direction.
2718 \end_layout
2719 \begin_layout Description
2720 Syntax paragraph-down-select
2721 \end_layout
2722 \begin_layout Description
2723 Origin Asger, 1 Oct 1996
2724 \end_layout
2725
2726 \begin_layout Subsection*
2727 LFUN_PARAGRAPH_GOTO
2728 \end_layout
2729 \begin_layout Description
2730 Action Jump to a paragraph given by its id number and optionally the desired position within the paragraph.
2731 \end_layout
2732 \begin_layout Description
2733 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).
2734 \end_layout
2735 \begin_layout Description
2736 Syntax paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
2737 \end_layout
2738 \begin_layout Description
2739 Params <PAR_ID_NUMBER>:  paragraph id
2740 \begin_inset Newline newline
2741 \end_inset
2742
2743 <POSITION_IN_PAR>: desired position within the paragraph
2744 \end_layout
2745 \begin_layout Description
2746 Origin Dekel, 26 Aug 2000
2747 \end_layout
2748
2749 \begin_layout Subsection*
2750 LFUN_BREAK_PARAGRAPH
2751 \end_layout
2752 \begin_layout Description
2753 Action Breaks the current paragraph at the current location.
2754 \end_layout
2755 \begin_layout Description
2756 Syntax break-paragraph
2757 \end_layout
2758
2759 \begin_layout Subsection*
2760 LFUN_BREAK_PARAGRAPH
2761 \end_layout
2762 \begin_layout Description
2763 Action Breaks the current paragraph at the current location.
2764 \end_layout
2765 \begin_layout Description
2766 Notion Removes the selection.
2767 \end_layout
2768 \begin_layout Description
2769 Syntax break-paragraph [<LAYOUT>]
2770 \end_layout
2771 \begin_layout Description
2772 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to default layout) when the cursor is at the end of the line.
2773 \end_layout
2774
2775 \begin_layout Subsection*
2776 LFUN_PARAGRAPH_PARAMS
2777 \end_layout
2778 \begin_layout Description
2779 Action Change paragraph settings.
2780 \end_layout
2781 \begin_layout Description
2782 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.
2783 \end_layout
2784 \begin_layout Description
2785 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
2786 \end_layout
2787 \begin_layout Description
2788 Params <INDENT>:  
2789 \backslash
2790 noindent|
2791 \backslash
2792 indent|
2793 \backslash
2794 indent-toggle|
2795 \backslash
2796 leftindent LENGTH
2797 \begin_inset Newline newline
2798 \end_inset
2799
2800 <SPACING>: 
2801 \backslash
2802 paragraph_spacing default|single|onehalf|double|other
2803 \begin_inset Newline newline
2804 \end_inset
2805
2806 <ALIGN>:   
2807 \backslash
2808 align block|left|right|center|default
2809 \begin_inset Newline newline
2810 \end_inset
2811
2812 <OTHERS>:  
2813 \backslash
2814 labelwidthstring WIDTH|
2815 \backslash
2816 start_of_appendix
2817 \end_layout
2818 \begin_layout Description
2819 Origin rgh, Aug 15 2007
2820 \end_layout
2821
2822 \begin_layout Subsection*
2823 LFUN_PARAGRAPH_PARAMS_APPLY
2824 \end_layout
2825 \begin_layout Description
2826 Action Change paragraph settings.
2827 \end_layout
2828 \begin_layout Description
2829 Notion Overwrite all nonspecified settings to the default ones. Use paragraph-params lfun if you don't want to overwrite others settings.
2830 \end_layout
2831 \begin_layout Description
2832 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
2833 \end_layout
2834 \begin_layout Description
2835 Params For parameters see LFUN_PARAGRAPH_PARAMS
2836 \end_layout
2837 \begin_layout Description
2838 Origin leeming, 30 Mar 2004
2839 \end_layout
2840
2841 \begin_layout Subsection*
2842 LFUN_PARAGRAPH_UPDATE
2843 \end_layout
2844 \begin_layout Description
2845 Action Updates the values inside the paragraph dialog from the paragraph.
2846 \end_layout
2847 \begin_layout Description
2848 Notion This is internal LFUN, not to be used by users. Called internally by LFUN_DIALOG_UPDATE.
2849 \end_layout
2850 \begin_layout Description
2851 Origin leeming, 13 Mar 2003
2852 \end_layout
2853
2854 \begin_layout Subsection*
2855 LFUN_OUTLINE_UP
2856 \end_layout
2857 \begin_layout Description
2858 Action Move the current group in the upward direction in the structure of the document.
2859 \end_layout
2860 \begin_layout Description
2861 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
2862 \end_layout
2863 \begin_layout Description
2864 Syntax outline-up
2865 \end_layout
2866 \begin_layout Description
2867 Origin Vermeer, 23 Mar 2006
2868 \end_layout
2869
2870 \begin_layout Subsection*
2871 LFUN_OUTLINE_DOWN
2872 \end_layout
2873 \begin_layout Description
2874 Action Move the current group in the downward direction in the structure of the document.
2875 \end_layout
2876 \begin_layout Description
2877 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
2878 \end_layout
2879 \begin_layout Description
2880 Syntax outline-down
2881 \end_layout
2882 \begin_layout Description
2883 Origin Vermeer, 23 Mar 2006
2884 \end_layout
2885
2886 \begin_layout Subsection*
2887 LFUN_OUTLINE_IN
2888 \end_layout
2889 \begin_layout Description
2890 Action Moves the current group in the downward direction in the hierarchy of the document structure.
2891 \end_layout
2892 \begin_layout Description
2893 Notion Part -> Chapter -> Section -> etc.
2894 \end_layout
2895 \begin_layout Description
2896 Syntax outline-in
2897 \end_layout
2898 \begin_layout Description
2899 Origin Vermeer, 23 Mar 2006
2900 \end_layout
2901
2902 \begin_layout Subsection*
2903 LFUN_OUTLINE_OUT
2904 \end_layout
2905 \begin_layout Description
2906 Action Moves the current group in the upward direction in the hierarchy of the document structure.
2907 \end_layout
2908 \begin_layout Description
2909 Notion Part <- Chapter <- Section <- etc.
2910 \end_layout
2911 \begin_layout Description
2912 Syntax outline-out
2913 \end_layout
2914 \begin_layout Description
2915 Origin Vermeer, 23 Mar 2006
2916 \end_layout
2917
2918 \begin_layout Subsection*
2919 LFUN_INSET_EDIT
2920 \end_layout
2921 \begin_layout Description
2922 Action Edit the inset at cursor with an external application, if one is attributed.
2923 \end_layout
2924 \begin_layout Description
2925 Syntax inset-edit [<INSET_PARAMS>]
2926 \end_layout
2927 \begin_layout Description
2928 Params <INSET_PARAMS>: Parameters for the inset.
2929 \begin_inset Newline newline
2930 \end_inset
2931
2932 Currently only the filename will be considered.
2933 \end_layout
2934 \begin_layout Description
2935 Origin JSpitzm, 27 Apr 2006
2936 \end_layout
2937
2938 \begin_layout Subsection*
2939 LFUN_TABULAR_INSERT
2940 \end_layout
2941 \begin_layout Description
2942 Action Inserts table into the document.
2943 \end_layout
2944 \begin_layout Description
2945 Syntax tabular-insert [<ROWS> <COLUMNS>]
2946 \end_layout
2947 \begin_layout Description
2948 Params In case no arguments are given show insert dialog.
2949 \end_layout
2950 \begin_layout Description
2951 Origin Jug, 12 Apr 2000
2952 \end_layout
2953
2954 \begin_layout Subsection*
2955 LFUN_TABULAR_FEATURE
2956 \end_layout
2957 \begin_layout Description
2958 Action Sets various features to the table/cell on the current cursor position.
2959 \end_layout
2960 \begin_layout Description
2961 Notion Various math-environment features are handled here as well, e.g. add-vline-left/right for the Grid/Array environment
2962 \end_layout
2963 \begin_layout Description
2964 Syntax tabular-feature <FEATURE> [<ARG>]
2965 \end_layout
2966 \begin_layout Description
2967 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
2968 \begin_inset Newline newline
2969 \end_inset
2970
2971 <ARG>: additional argument for some commands, use debug mode to explore its values.
2972 \end_layout
2973 \begin_layout Description
2974 Origin Jug, 28 Jul 2000
2975 \end_layout
2976
2977 \begin_layout Subsection*
2978 LFUN_CELL_BACKWARD
2979 \end_layout
2980 \begin_layout Description
2981 Action Moves the cursor to the previous cell inside the table.
2982 \end_layout
2983 \begin_layout Description
2984 Syntax cell-backward
2985 \end_layout
2986 \begin_layout Description
2987 Origin Jug, 22 May 2000
2988 \end_layout
2989
2990 \begin_layout Subsection*
2991 LFUN_CELL_FORWARD
2992 \end_layout
2993 \begin_layout Description
2994 Action Moves the cursor to the next cell inside the table.
2995 \end_layout
2996 \begin_layout Description
2997 Syntax cell-forward
2998 \end_layout
2999
3000 \begin_layout Subsection*
3001 LFUN_CELL_SPLIT
3002 \end_layout
3003 \begin_layout Description
3004 Action Splits cell and shifts right part to the next cell (inside the math grid).
3005 \end_layout
3006 \begin_layout Description
3007 Syntax cell-split
3008 \end_layout
3009 \begin_layout Description
3010 Origin Ale, 15 May 1997
3011 \end_layout
3012
3013 \begin_layout Subsection*
3014 LFUN_VC_REGISTER
3015 \end_layout
3016 \begin_layout Description
3017 Action Register the document as an file inside version control system (RCS, CVS).
3018 \end_layout
3019 \begin_layout Description
3020 Notion File is registered inside cvs, svn or rcs repository acording to the existence of cvs/svn/rcs entries in the document's directory.
3021 \begin_inset Newline newline
3022 \end_inset
3023
3024 See LyX Additional Features Manual (Version Control Chapter) for additional information.
3025 \end_layout
3026 \begin_layout Description
3027 Syntax vc-register
3028 \end_layout
3029 \begin_layout Description
3030 Origin Lgb, 1 Jul 1997
3031 \end_layout
3032
3033 \begin_layout Subsection*
3034 LFUN_VC_CHECK_IN
3035 \end_layout
3036 \begin_layout Description
3037 Action Checks-in/commits the changes of the registered file to the repository.
3038 \end_layout
3039 \begin_layout Description
3040 Notion In RCS case this also unlocks the file.
3041 \end_layout
3042 \begin_layout Description
3043 Syntax vc-check-in
3044 \end_layout
3045 \begin_layout Description
3046 Origin Lgb, 1 Jul 1997
3047 \end_layout
3048
3049 \begin_layout Subsection*
3050 LFUN_VC_CHECK_OUT
3051 \end_layout
3052 \begin_layout Description
3053 Action Checks-out the document for edit (and locks it for RCS).
3054 \end_layout
3055 \begin_layout Description
3056 Notion This is implemented only for RCS and SVN, not CVS.
3057 \end_layout
3058 \begin_layout Description
3059 Syntax vc-check-out
3060 \end_layout
3061 \begin_layout Description
3062 Origin Lgb, 1 Jul 1997
3063 \end_layout
3064
3065 \begin_layout Subsection*
3066 LFUN_VC_REVERT
3067 \end_layout
3068 \begin_layout Description
3069 Action Reverts the document to the last check-in/commit in VCS.
3070 \end_layout
3071 \begin_layout Description
3072 Syntax vc-revert
3073 \end_layout
3074 \begin_layout Description
3075 Origin Lgb, 1 Jul 1997
3076 \end_layout
3077
3078 \begin_layout Subsection*
3079 LFUN_VC_UNDO_LAST
3080 \end_layout
3081 \begin_layout Description
3082 Action Undo last check-in.
3083 \end_layout
3084 \begin_layout Description
3085 Notion This is currently implemented only for RCS.
3086 \end_layout
3087 \begin_layout Description
3088 Syntax vc-check-out
3089 \end_layout
3090 \begin_layout Description
3091 Origin Lgb, 1 Jul 1997
3092 \end_layout
3093
3094 \begin_layout Subsection*
3095 LFUN_VC_COMMAND
3096 \end_layout
3097 \begin_layout Description
3098 Action Executes external command. This command is intended to support additional VCS commands.
3099 \end_layout
3100 \begin_layout Description
3101 Syntax vc-command <FLAG> <PATH> <COMMAND>
3102 \end_layout
3103 \begin_layout Description
3104 Params  <FLAG>: Flags for the command can be combined together.
3105 \begin_inset Newline newline
3106 \end_inset
3107
3108 U - dUmmy - no flags
3109 \begin_inset Newline newline
3110 \end_inset
3111
3112 D - Doc - need document loaded to proceed
3113 \begin_inset Newline newline
3114 \end_inset
3115
3116 I - dIrty - mark document dirty
3117 \begin_inset Newline newline
3118 \end_inset
3119
3120 R - Reload - ensure that the document is saved and reload it after command execution
3121 \begin_inset Newline newline
3122 \end_inset
3123
3124 M - Message - ask for input string (commit message)
3125 \begin_inset Newline newline
3126 \end_inset
3127
3128 <PATH>: path where to start. $$p will be replaced by the current document path.
3129 \begin_inset Newline newline
3130 \end_inset
3131
3132 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current document/path/message.
3133 \end_layout
3134 \begin_layout Description
3135 Sample vc-command DR $$p "svn up"
3136 \end_layout
3137 \begin_layout Description
3138 Origin sanda, 13 Jan 2009
3139 \end_layout
3140
3141 \begin_layout Subsection*
3142 LFUN_CHANGES_TRACK
3143 \end_layout
3144 \begin_layout Description
3145 Action Toggles change tracking to on/off.
3146 \end_layout
3147 \begin_layout Description
3148 Syntax changes-track
3149 \end_layout
3150 \begin_layout Description
3151 Origin levon, 1 Oct 2002
3152 \end_layout
3153
3154 \begin_layout Subsection*
3155 LFUN_CHANGES_OUTPUT
3156 \end_layout
3157 \begin_layout Description
3158 Action Toggles showing of change tracking in typesetted output.
3159 \end_layout
3160 \begin_layout Description
3161 Syntax changes-output
3162 \end_layout
3163 \begin_layout Description
3164 Origin jspitzm, 21 Jan 2005
3165 \end_layout
3166
3167 \begin_layout Subsection*
3168 LFUN_CHANGE_NEXT
3169 \end_layout
3170 \begin_layout Description
3171 Action Moves the cursor to the position of the next change of the change tracking records.
3172 \end_layout
3173 \begin_layout Description
3174 Syntax change-next
3175 \end_layout
3176 \begin_layout Description
3177 Origin schmitt, 4 Oct 2006
3178 \end_layout
3179
3180 \begin_layout Subsection*
3181 LFUN_CHANGE_PREVIOUS
3182 \end_layout
3183 \begin_layout Description
3184 Action Moves the cursor to the position of the previous change of the change tracking records.
3185 \end_layout
3186 \begin_layout Description
3187 Syntax change-previous
3188 \end_layout
3189 \begin_layout Description
3190 Origin vfr, 4 Apr 2009
3191 \end_layout
3192
3193 \begin_layout Subsection*
3194 LFUN_CHANGES_MERGE
3195 \end_layout
3196 \begin_layout Description
3197 Action Open change tracking dialog for merging and moves the cursor to the position of the next change.
3198 \end_layout
3199 \begin_layout Description
3200 Syntax changes-merge
3201 \end_layout
3202 \begin_layout Description
3203 Origin Levon, 16 Oct 2002
3204 \end_layout
3205
3206 \begin_layout Subsection*
3207 LFUN_CHANGE_ACCEPT
3208 \end_layout
3209 \begin_layout Description
3210 Action Accepts tracked change inside the selection.
3211 \end_layout
3212 \begin_layout Description
3213 Syntax change-accept
3214 \end_layout
3215 \begin_layout Description
3216 Origin Levon, 16 Oct 2002
3217 \end_layout
3218
3219 \begin_layout Subsection*
3220 LFUN_CHANGE_REJECT
3221 \end_layout
3222 \begin_layout Description
3223 Action Rejects tracked change inside the selection.
3224 \end_layout
3225 \begin_layout Description
3226 Syntax change-accept
3227 \end_layout
3228 \begin_layout Description
3229 Origin Levon, 16 Oct 2002
3230 \end_layout
3231
3232 \begin_layout Subsection*
3233 LFUN_ALL_CHANGES_ACCEPT
3234 \end_layout
3235 \begin_layout Description
3236 Action Accepts all tracked changes in the document.
3237 \end_layout
3238 \begin_layout Description
3239 Syntax all-changes-accept
3240 \end_layout
3241 \begin_layout Description
3242 Origin Levon, 16 Oct 2002
3243 \end_layout
3244
3245 \begin_layout Subsection*
3246 LFUN_ALL_CHANGES_REJECT
3247 \end_layout
3248 \begin_layout Description
3249 Action Rejects all tracked changes in the document.
3250 \end_layout
3251 \begin_layout Description
3252 Notion Reject does not work recursively; the user may have to repeat the operation.
3253 \end_layout
3254 \begin_layout Description
3255 Syntax all-changes-reject
3256 \end_layout
3257 \begin_layout Description
3258 Origin Levon, 16 Oct 2002
3259 \end_layout
3260
3261 \begin_layout Subsection*
3262 LFUN_INSET_APPLY
3263 \end_layout
3264 \begin_layout Description
3265 Action Apply data for an inset.
3266 \end_layout
3267 \begin_layout Description
3268 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.
3269 \end_layout
3270 \begin_layout Description
3271 Syntax inset-apply <ARGS>
3272 \end_layout
3273 \begin_layout Description
3274 Params See LFUN_INSET_INSERT .
3275 \end_layout
3276
3277 \begin_layout Subsection*
3278 LFUN_INSET_DISSOLVE
3279 \end_layout
3280 \begin_layout Description
3281 Action Dissolve the current inset into text.
3282 \end_layout
3283 \begin_layout Description
3284 Syntax inset-dissolve [<INSET>]
3285 \end_layout
3286 \begin_layout Description
3287 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.
3288 \begin_inset Newline newline
3289 \end_inset
3290
3291 For values see lyx::InsetLayout::lyxtype_ .
3292 \end_layout
3293 \begin_layout Description
3294 Origin JSpitz, 7 Aug 2006
3295 \end_layout
3296
3297 \begin_layout Subsection*
3298 LFUN_INSET_INSERT
3299 \end_layout
3300 \begin_layout Description
3301 Action Insert new inset (type given by the parameters).
3302 \end_layout
3303 \begin_layout Description
3304 Syntax inset-insert <INSET> <ARGS>
3305 \end_layout
3306 \begin_layout Description
3307 Params <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics| hyperlink|include|index|label|nomencl|vspace|ref|toc>
3308 \begin_inset Newline newline
3309 \end_inset
3310
3311 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
3312 \end_layout
3313 \begin_layout Description
3314 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
3315 \backslash
3316 end_inset
3317 \begin_inset Newline newline
3318 \end_inset
3319
3320 where <label name> is the name of the referenced label and <Format> is one of the following:
3321 \begin_inset Newline newline
3322 \end_inset
3323
3324 ref -- <reference>
3325 \begin_inset Newline newline
3326 \end_inset
3327
3328 eqref -- (<reference>)
3329 \begin_inset Newline newline
3330 \end_inset
3331
3332 pageref -- <page>
3333 \begin_inset Newline newline
3334 \end_inset
3335
3336 vpageref -- on <page>
3337 \begin_inset Newline newline
3338 \end_inset
3339
3340 vref -- <reference> on <page>
3341 \begin_inset Newline newline
3342 \end_inset
3343
3344 prettyref -- Formatted reference
3345 \end_layout
3346
3347 \begin_layout Subsection*
3348 LFUN_INSET_MODIFY
3349 \end_layout
3350 \begin_layout Description
3351 Action Modify existing inset.
3352 \end_layout
3353 \begin_layout Description
3354 Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats, graphics, include, label, listings, note, phantom, ref, space, tabular, vspace, wrap insets.
3355 \end_layout
3356 \begin_layout Description
3357 Syntax inset-modify <INSET> <ARGS>
3358 \end_layout
3359 \begin_layout Description
3360 Params See LFUN_INSET_INSERT for further details.
3361 \end_layout
3362
3363 \begin_layout Subsection*
3364 LFUN_NEXT_INSET_MODIFY
3365 \end_layout
3366 \begin_layout Description
3367 Action Modify the inset at cursor position, if there is one.
3368 \end_layout
3369 \begin_layout Description
3370 Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats, graphics, include, label, listings, note, phantom, ref, space, tabular, vspace, wrap insets.
3371 \end_layout
3372 \begin_layout Description
3373 Syntax next-inset-modify <INSET> <ARGS>next-inset-modify changetype <TYPE>
3374 \end_layout
3375 \begin_layout Description
3376 Params See LFUN_INSET_INSERT for further details.
3377 \end_layout
3378 \begin_layout Description
3379 Origin JSpitzm, 23 Mar 2008
3380 \end_layout
3381
3382 \begin_layout Subsection*
3383 LFUN_INSET_DIALOG_UPDATE
3384 \end_layout
3385 \begin_layout Description
3386 Action Updates the values inside the dialog from the inset.
3387 \end_layout
3388 \begin_layout Description
3389 Notion This is internal LFUN, not to be used by users. Called internally by LFUN_DIALOG_UPDATE
3390 \end_layout
3391 \begin_layout Description
3392 Params <DIALOG-NAME>
3393 \end_layout
3394 \begin_layout Description
3395 Origin leeming, 25 Feb 2003
3396 \end_layout
3397
3398 \begin_layout Subsection*
3399 LFUN_INSET_SETTINGS
3400 \end_layout
3401 \begin_layout Description
3402 Action Open the inset's properties dialog.
3403 \end_layout
3404 \begin_layout Description
3405 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.
3406 \end_layout
3407 \begin_layout Description
3408 Syntax inset-settings <INSET>
3409 \end_layout
3410 \begin_layout Description
3411 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>.
3412 \end_layout
3413
3414 \begin_layout Subsection*
3415 LFUN_INSET_TOGGLE
3416 \end_layout
3417 \begin_layout Description
3418 Action Toggles the collapsable inset at cursor position, or the inset we are currently in.
3419 \end_layout
3420 \begin_layout Description
3421 Syntax inset-toggle [<ARG>]
3422 \end_layout
3423 \begin_layout Description
3424 Params <ARG>: <open|close|toggle|assign>.
3425 \begin_inset Newline newline
3426 \end_inset
3427
3428 open/close/toggle are for collapsable insets. toggle is used when no argument is given.
3429 \begin_inset Newline newline
3430 \end_inset
3431
3432 assign synchronize the branch-inset with activation status of the branch. Used for global toggling when changed activation.
3433 \end_layout
3434 \begin_layout Description
3435 Origin lasgouttes, 19 Jul 2001
3436 \end_layout
3437
3438 \begin_layout Subsection*
3439 LFUN_ALL_INSETS_TOGGLE
3440 \end_layout
3441 \begin_layout Description
3442 Action Toggles (open/closes) all collapsable insets (of a given type) in the document.
3443 \end_layout
3444 \begin_layout Description
3445 Notion Used for box, branch, ert, float, listings, note, tabular, wrap insets.
3446 \end_layout
3447 \begin_layout Description
3448 Syntax all-insets-toggle [<STATE>] [<INSET>]
3449 \end_layout
3450 \begin_layout Description
3451 Params <STATE>: <toggle|open|close|assign> default: toggle
3452 \begin_inset Newline newline
3453 \end_inset
3454
3455 <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets
3456 \end_layout
3457 \begin_layout Description
3458 Origin leeming, 30 Mar 2004
3459 \end_layout
3460
3461 \begin_layout Subsection*
3462 LFUN_SET_GRAPHICS_GROUP
3463 \end_layout
3464 \begin_layout Description
3465 Action Set the group for the graphics inset on the cursor position.
3466 \end_layout
3467 \begin_layout Description
3468 Syntax set-graphics-group [<GROUP>]
3469 \end_layout
3470 \begin_layout Description
3471 Params <GROUP>: Id for an existing group. In case the Id is an empty string, the graphics inset is removed from the current group.
3472 \end_layout
3473 \begin_layout Description
3474 Origin sanda, 6 May 2008
3475 \end_layout
3476
3477 \begin_layout Subsection*
3478 LFUN_FINISHED_FORWARD
3479 \end_layout
3480 \begin_layout Description
3481 Action Moves the cursor out of the current slice, going forward.
3482 \end_layout
3483 \begin_layout Description
3484 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.
3485 \end_layout
3486
3487 \begin_layout Subsection*
3488 LFUN_FINISHED_BACKWARD
3489 \end_layout
3490 \begin_layout Description
3491 Action Moves the cursor out of the current slice, going backwards.
3492 \end_layout
3493 \begin_layout Description
3494 Notion See also LFUN_FINISHED_FORWARD.
3495 \end_layout
3496
3497 \begin_layout Subsection*
3498 LFUN_FINISHED_RIGHT
3499 \end_layout
3500 \begin_layout Description
3501 Action Moves the cursor out of the current slice, going right.
3502 \end_layout
3503 \begin_layout Description
3504 Notion See also LFUN_FINISHED_FORWARD
3505 \end_layout
3506
3507 \begin_layout Subsection*
3508 LFUN_FINISHED_LEFT
3509 \end_layout
3510 \begin_layout Description
3511 Action Moves the cursor out of the current slice, going left.
3512 \end_layout
3513 \begin_layout Description
3514 Notion See also LFUN_FINISHED_FORWARD.
3515 \end_layout
3516
3517 \begin_layout Subsection*
3518 LFUN_LANGUAGE
3519 \end_layout
3520 \begin_layout Description
3521 Action Set language from the current cursor position.
3522 \end_layout
3523 \begin_layout Description
3524 Syntax language <LANG>
3525 \end_layout
3526 \begin_layout Description
3527 Params <LANG>: Requested language. Look in lib/languages for the list.
3528 \end_layout
3529 \begin_layout Description
3530 Origin Dekel, 2 Mar 2000
3531 \end_layout
3532
3533 \begin_layout Subsection*
3534 LFUN_LABEL_GOTO
3535 \end_layout
3536 \begin_layout Description
3537 Action Goto a label.
3538 \end_layout
3539 \begin_layout Description
3540 Syntax label-goto [<LABEL>]
3541 \end_layout
3542 \begin_layout Description
3543 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.
3544 \end_layout
3545 \begin_layout Description
3546 Origin Ale, 6 Aug 1997
3547 \end_layout
3548
3549 \begin_layout Subsection*
3550 LFUN_LABEL_INSERT
3551 \end_layout
3552 \begin_layout Description
3553 Action Inserts label to text or displayed formula.
3554 \end_layout
3555 \begin_layout Description
3556 Syntax label-insert [<LABEL>]
3557 \end_layout
3558 \begin_layout Description
3559 Params <LABEL>: Requested label. If no label is given dialog requesting name will be opened.
3560 \end_layout
3561
3562 \begin_layout Subsection*
3563 LFUN_REFERENCE_NEXT
3564 \end_layout
3565 \begin_layout Description
3566 Action Go to the next label or cross-reference.
3567 \end_layout
3568 \begin_layout Description
3569 Syntax reference-next
3570 \end_layout
3571 \begin_layout Description
3572 Origin Dekel, 14 Jan 2001
3573 \end_layout
3574
3575 \begin_layout Subsection*
3576 LFUN_BOOKMARK_GOTO
3577 \end_layout
3578 \begin_layout Description
3579 Action Moves the cursor to the numbered bookmark, opening the file if necessary. Note that bookmarsk are saved per-session, not per file.
3580 \end_layout
3581 \begin_layout Description
3582 Notion Bookmark 0 has a special purpose. It is automatically set
3583 \begin_inset Newline newline
3584 \end_inset
3585
3586 1. to the paragraph you are currently editing
3587 \begin_inset Newline newline
3588 \end_inset
3589
3590 2. to the paragraph from where you are jumping to the last-edited position (jump-back feature)
3591 \begin_inset Newline newline
3592 \end_inset
3593
3594 3. when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
3595 \end_layout
3596 \begin_layout Description
3597 Syntax bookmark-goto <NUMBER>
3598 \end_layout
3599 \begin_layout Description
3600 Params <NUMBER>: the number of the bookmark to restore.
3601 \end_layout
3602 \begin_layout Description
3603 Origin Dekel, 27 January 2001
3604 \end_layout
3605
3606 \begin_layout Subsection*
3607 LFUN_BOOKMARK_SAVE
3608 \end_layout
3609 \begin_layout Description
3610 Action Save a bookmark.
3611 \end_layout
3612 \begin_layout Description
3613 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.
3614 \end_layout
3615 \begin_layout Description
3616 Syntax bookmark-save <NUMBER>
3617 \end_layout
3618 \begin_layout Description
3619 Params <NUMBER>: the number of the bookmark to save.
3620 \end_layout
3621 \begin_layout Description
3622 Origin Dekel, 27 January 2001
3623 \end_layout
3624
3625 \begin_layout Subsection*
3626 LFUN_BOOKMARK_CLEAR
3627 \end_layout
3628 \begin_layout Description
3629 Action Clears the list of saved bookmarks.
3630 \end_layout
3631 \begin_layout Description
3632 Syntax bookmark-clear
3633 \end_layout
3634 \begin_layout Description
3635 Origin bpeng, 31 October 2006
3636 \end_layout
3637
3638 \begin_layout Subsection*
3639 LFUN_HELP_OPEN
3640 \end_layout
3641 \begin_layout Description
3642 Action Open the given help file according to the language setting.
3643 \end_layout
3644 \begin_layout Description
3645 Syntax help-open <FILE>[.lyx]
3646 \end_layout
3647 \begin_layout Description
3648 Params <FILE>: any document from (/usr/share/)doc directory.
3649 \end_layout
3650 \begin_layout Description
3651 Origin Jug, 27 Jun 1999
3652 \end_layout
3653
3654 \begin_layout Subsection*
3655 LFUN_LYX_QUIT
3656 \end_layout
3657 \begin_layout Description
3658 Action Terminates the current LyX instance.
3659 \end_layout
3660 \begin_layout Description
3661 Notion Terminates the current LyX instance, asking whether to save modified documents, etc.
3662 \end_layout
3663 \begin_layout Description
3664 Syntax lyx-quit
3665 \end_layout
3666
3667 \begin_layout Subsection*
3668 LFUN_TOOLBAR_TOGGLE
3669 \end_layout
3670 \begin_layout Description
3671 Action Toggles visibility of a given toolbar between on/off/auto.
3672 \end_layout
3673 \begin_layout Description
3674 Notion Skiping "auto" when allowauto is false.
3675 \end_layout
3676 \begin_layout Description
3677 Syntax toolbar-toggle <NAME> [allowauto]
3678 \end_layout
3679 \begin_layout Description
3680 Params <NAME>: standard|extra|table|math|mathmacrotemplate| minibuffer|review|view/update|math_panels|vcs
3681 \end_layout
3682 \begin_layout Description
3683 Origin Edwin, 21 May 2007
3684 \end_layout
3685
3686 \begin_layout Subsection*
3687 LFUN_MENU_OPEN
3688 \end_layout
3689 \begin_layout Description
3690 Action Opens the menu given by its name.
3691 \end_layout
3692 \begin_layout Description
3693 Syntax menu-open <NAME>
3694 \end_layout
3695 \begin_layout Description
3696 Params <NAME>: menu name. See various .inc files in lib/ui for candidates.
3697 \end_layout
3698
3699 \begin_layout Subsection*
3700 LFUN_UI_TOGGLE
3701 \end_layout
3702 \begin_layout Description
3703 Action Various UI visibility-toggling actions.
3704 \end_layout
3705 \begin_layout Description
3706 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
3707 \end_layout
3708 \begin_layout Description
3709 Params statusbar  : Toggle visibility of the statusbar.
3710 \begin_inset Newline newline
3711 \end_inset
3712
3713 menubar    : Toggle visibility of the menubar.
3714 \begin_inset Newline newline
3715 \end_inset
3716
3717 scrollbar  : Toggle visibility of the scrollbar.
3718 \begin_inset Newline newline
3719 \end_inset
3720
3721 frame      : Toggle visibility of the frames around editing window.
3722 \begin_inset Newline newline
3723 \end_inset
3724
3725 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.
3726 \end_layout
3727 \begin_layout Description
3728 Origin sanda, 9 Feb 2007
3729 \end_layout
3730
3731 \begin_layout Subsection*
3732 LFUN_WINDOW_NEW
3733 \end_layout
3734 \begin_layout Description
3735 Action Creates new empty LyX window.
3736 \end_layout
3737 \begin_layout Description
3738 Notion Already opened documents from the previous window can be found under View menu.
3739 \end_layout
3740 \begin_layout Description
3741 Syntax window-new [<GEOMETRY>]
3742 \end_layout
3743 \begin_layout Description
3744 Params <GEOMETRY>: pass the geometry of the window. This parameter is currently accepted only on Windows platform.
3745 \end_layout
3746 \begin_layout Description
3747 Origin Abdel, 21 Oct 2006
3748 \end_layout
3749
3750 \begin_layout Subsection*
3751 LFUN_WINDOW_CLOSE
3752 \end_layout
3753 \begin_layout Description
3754 Action Closes the current LyX window.
3755 \end_layout
3756 \begin_layout Description
3757 Syntax window-close
3758 \end_layout
3759 \begin_layout Description
3760 Origin Abdel, 23 Oct 2006
3761 \end_layout
3762
3763 \begin_layout Subsection*
3764 LFUN_SPLIT_VIEW
3765 \end_layout
3766 \begin_layout Description
3767 Action Creates another split view of current buffer.
3768 \end_layout
3769 \begin_layout Description
3770 Notion All split views act in the same way indpendently.
3771 \end_layout
3772 \begin_layout Description
3773 Syntax split-view <vertical|horizontal>
3774 \end_layout
3775 \begin_layout Description
3776 Params horizontal : The work areas are laid out side by side.
3777 \begin_inset Newline newline
3778 \end_inset
3779
3780 vertical   : The work areas laid out vertically.
3781 \end_layout
3782 \begin_layout Description
3783 Origin Abdel, 20 Feb 2008
3784 \end_layout
3785
3786 \begin_layout Subsection*
3787 LFUN_CLOSE_TAB_GROUP
3788 \end_layout
3789 \begin_layout Description
3790 Action Close the current tab group.
3791 \end_layout
3792 \begin_layout Description
3793 Notion This only closes the work areas, not the buffer themselves. The still opened buffers can be visualized in another tab group.
3794 \end_layout
3795 \begin_layout Description
3796 Syntax close-tab-group
3797 \end_layout
3798 \begin_layout Description
3799 Origin Abdel, 21 Feb 2008
3800 \end_layout
3801
3802 \begin_layout Subsection*
3803 LFUN_DIALOG_SHOW
3804 \end_layout
3805 \begin_layout Description
3806 Action Shows hidden dialog or create new one for a given function/inset settings etc.
3807 \end_layout
3808 \begin_layout Description
3809 Syntax dialog-show <NAME> [<DATA>]
3810 \end_layout
3811 \begin_layout Description
3812 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
3813 \begin_inset Newline newline
3814 \end_inset
3815
3816 document|errorlist|ert|external|file|findreplace|findreplaceadv|float|graphics|
3817 \begin_inset Newline newline
3818 \end_inset
3819
3820 href|include|index|index_print|info|nomenclature|label|listings|log|mathdelimiter|
3821 \begin_inset Newline newline
3822 \end_inset
3823
3824 mathmatrix|mathspace|note|paragraph|phantom|prefs|print|ref|sendto|space|
3825 \begin_inset Newline newline
3826 \end_inset
3827
3828 spellchecker|symbols|tabular|tabularcreate|thesaurus|texinfo|toc|
3829 \begin_inset Newline newline
3830 \end_inset
3831
3832 view-source|vspace|wrap|<SPECIAL>
3833 \begin_inset Newline newline
3834 \end_inset
3835
3836 <SPECIAL>: latexlog|vclog
3837 \begin_inset Newline newline
3838 \end_inset
3839
3840 <DATA>: data, usually settings for the given dialog. Use debug mode for the details.
3841 \end_layout
3842 \begin_layout Description
3843 Origin leeming, 17 Jun 2003
3844 \end_layout
3845
3846 \begin_layout Subsection*
3847 LFUN_DIALOG_SHOW_NEW_INSET
3848 \end_layout
3849 \begin_layout Description
3850 Action Shows hidden dialog or create new one for a given inset settings etc.
3851 \end_layout
3852 \begin_layout Description
3853 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given inset.
3854 \end_layout
3855 \begin_layout Description
3856 Syntax dialog-show-new-inset <NAME> [<DATA>]
3857 \end_layout
3858 \begin_layout Description
3859 Params See LFUN_DIALOG_SHOW .
3860 \end_layout
3861 \begin_layout Description
3862 Origin leeming, 25 Feb 2003
3863 \end_layout
3864
3865 \begin_layout Subsection*
3866 LFUN_DIALOG_UPDATE
3867 \end_layout
3868 \begin_layout Description
3869 Action Updates the dialog values from the inset/paragraph/document.
3870 \end_layout
3871 \begin_layout Description
3872 Syntax dialog-update <NAME>
3873 \end_layout
3874 \begin_layout Description
3875 Params <NAME>: paragraph|prefs|<INSET>
3876 \begin_inset Newline newline
3877 \end_inset
3878
3879 <INSET>: inset name
3880 \end_layout
3881 \begin_layout Description
3882 Origin leeming, 25 Feb 2003
3883 \end_layout
3884
3885 \begin_layout Subsection*
3886 LFUN_DIALOG_HIDE
3887 \end_layout
3888 \begin_layout Description
3889 Action Hides showed dialog. Counterpart to LFUN_DIALOG_SHOW .
3890 \end_layout
3891 \begin_layout Description
3892 Syntax dialog-hide <NAME>
3893 \end_layout
3894 \begin_layout Description
3895 Params See LFUN_DIALOG_SHOW .
3896 \end_layout
3897 \begin_layout Description
3898 Origin leeming, 25 Feb 2003
3899 \end_layout
3900
3901 \begin_layout Subsection*
3902 LFUN_DIALOG_TOGGLE
3903 \end_layout
3904 \begin_layout Description
3905 Action Toggles dialog between showed/hidden state.
3906 \end_layout
3907 \begin_layout Description
3908 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
3909 \end_layout
3910 \begin_layout Description
3911 Syntax dialog-toggle <NAME> [<DATA>]
3912 \end_layout
3913 \begin_layout Description
3914 Params See LFUN_DIALOG_SHOW .
3915 \end_layout
3916 \begin_layout Description
3917 Origin JSpitzm, 30 Apr 2007
3918 \end_layout
3919
3920 \begin_layout Subsection*
3921 LFUN_DIALOG_DISCONNECT_INSET
3922 \end_layout
3923 \begin_layout Description
3924 Action Closes opened connection to opened inset.
3925 \end_layout
3926 \begin_layout Description
3927 Notion Connection is used for apply functions.
3928 \end_layout
3929 \begin_layout Description
3930 Syntax dialog-disconnect-inset <INSET-NAME>
3931 \end_layout
3932 \begin_layout Description
3933 Origin leeming, 25 Feb 2003
3934 \end_layout
3935
3936 \begin_layout Subsection*
3937 LFUN_MOUSE_PRESS
3938 \end_layout
3939 \begin_layout Description
3940 Action This function is called when mouse button is pressed (inside workarea). Action depends on the context.
3941 \end_layout
3942 \begin_layout Description
3943 Notion This is internal LFUN, not to be used by users.
3944 \end_layout
3945 \begin_layout Description
3946 Origin Andre, 9 Aug 2002
3947 \end_layout
3948
3949 \begin_layout Subsection*
3950 LFUN_MOUSE_DOUBLE
3951 \end_layout
3952 \begin_layout Description
3953 Action This function is called when double click on mouse button is pressed (inside workarea). Action depends on the context.
3954 \end_layout
3955 \begin_layout Description
3956 Notion This is internal LFUN, not to be used by users.
3957 \end_layout
3958 \begin_layout Description
3959 Origin Andre, 9 Aug 2002
3960 \end_layout
3961
3962 \begin_layout Subsection*
3963 LFUN_MOUSE_TRIPLE
3964 \end_layout
3965 \begin_layout Description
3966 Action This function is called when triple click on mouse button is pressed (inside workarea). Action depends on the context.
3967 \end_layout
3968 \begin_layout Description
3969 Notion This is internal LFUN, not to be used by users.
3970 \end_layout
3971 \begin_layout Description
3972 Origin Andre, 9 Aug 2002
3973 \end_layout
3974
3975 \begin_layout Subsection*
3976 LFUN_MOUSE_MOTION
3977 \end_layout
3978 \begin_layout Description
3979 Action This function is called when mouse cursor is moving over the text. Action depends on the context.
3980 \end_layout
3981 \begin_layout Description
3982 Notion This is internal LFUN, not to be used by users.
3983 \end_layout
3984 \begin_layout Description
3985 Origin Andre, 9 Aug 2002
3986 \end_layout
3987
3988 \begin_layout Subsection*
3989 LFUN_MOUSE_RELEASE
3990 \end_layout
3991 \begin_layout Description
3992 Action This function is called when mouse button is released (inside workarea). Action depends on the context.
3993 \end_layout
3994 \begin_layout Description
3995 Notion This is internal LFUN, not to be used by users.
3996 \end_layout
3997 \begin_layout Description
3998 Origin Andre, 9 Aug 2002
3999 \end_layout
4000
4001 \begin_layout Subsection*
4002 LFUN_KEYMAP_OFF
4003 \end_layout
4004 \begin_layout Description
4005 Action Turn off the loaded keyboard map.
4006 \end_layout
4007 \begin_layout Description
4008 Syntax keymap-off
4009 \end_layout
4010
4011 \begin_layout Subsection*
4012 LFUN_KEYMAP_PRIMARY
4013 \end_layout
4014 \begin_layout Description
4015 Action Turn on the primary keyboard map.
4016 \end_layout
4017 \begin_layout Description
4018 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.
4019 \begin_inset Newline newline
4020 \end_inset
4021
4022 The language is to be set in the Preferences dialog.
4023 \end_layout
4024 \begin_layout Description
4025 Syntax keymap-primary
4026 \end_layout
4027
4028 \begin_layout Subsection*
4029 LFUN_KEYMAP_SECONDARY
4030 \end_layout
4031 \begin_layout Description
4032 Action Turn on the secondary keyboard map.
4033 \end_layout
4034 \begin_layout Description
4035 Syntax keymap-secondary
4036 \end_layout
4037
4038 \begin_layout Subsection*
4039 LFUN_KEYMAP_TOGGLE
4040 \end_layout
4041 \begin_layout Description
4042 Action Toggles keyboard maps (first/second/off).
4043 \end_layout
4044 \begin_layout Description
4045 Syntax keymap-toggle
4046 \end_layout
4047 \begin_layout Description
4048 Origin leeming, 30 Mar 2004
4049 \end_layout
4050
4051 \begin_layout Subsection*
4052 LFUN_SERVER_GET_LAYOUT
4053 \end_layout
4054 \begin_layout Description
4055 Action Returns the current layout (that is environment) name on the cursor position.
4056 \end_layout
4057 \begin_layout Description
4058 Syntax server-get-layout
4059 \end_layout
4060
4061 \begin_layout Subsection*
4062 LFUN_SERVER_GET_FILENAME
4063 \end_layout
4064 \begin_layout Description
4065 Action Returns path and file name of the currently edited document.
4066 \end_layout
4067 \begin_layout Description
4068 Syntax server-get-filename
4069 \end_layout
4070
4071 \begin_layout Subsection*
4072 LFUN_SERVER_GOTO_FILE_ROW
4073 \end_layout
4074 \begin_layout Description
4075 Action Sets the cursor position based on the row number of generated TeX file.
4076 \end_layout
4077 \begin_layout Description
4078 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).
4079 \end_layout
4080 \begin_layout Description
4081 Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
4082 \end_layout
4083 \begin_layout Description
4084 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.
4085 \begin_inset Newline newline
4086 \end_inset
4087
4088 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.
4089 \end_layout
4090 \begin_layout Description
4091 Origin Edmar, 23 Dec 1998
4092 \end_layout
4093
4094 \begin_layout Subsection*
4095 LFUN_SERVER_NOTIFY
4096 \end_layout
4097 \begin_layout Description
4098 Action Sends notify message about the last key-sequence to client.
4099 \end_layout
4100 \begin_layout Description
4101 Notion This can be used to grab last key-sequence used inside the LyX window. See also Debug extensions section in Additional features manual.
4102 \end_layout
4103 \begin_layout Description
4104 Syntax server-notify
4105 \end_layout
4106
4107 \begin_layout Subsection*
4108 LFUN_SERVER_SET_XY
4109 \end_layout
4110 \begin_layout Description
4111 Action Sets the cursor position based on the editing area coordinates (similar as clicking on that point with left mouse button).
4112 \end_layout
4113 \begin_layout Description
4114 Syntax server-set-xy <X> <Y>
4115 \end_layout
4116
4117 \begin_layout Subsection*
4118 LFUN_SERVER_GET_XY
4119 \end_layout
4120 \begin_layout Description
4121 Action Returns the coordinates of cursor position in the editing area.
4122 \end_layout
4123 \begin_layout Description
4124 Syntax server-get-xy
4125 \end_layout
4126
4127 \begin_layout Subsection*
4128 LFUN_BUILD_PROGRAM
4129 \end_layout
4130 \begin_layout Description
4131 Action Generates the code (literate programming).
4132 \end_layout
4133 \begin_layout Description
4134 Notion Latex file with extension 
4135 \backslash
4136 literate_extension is generated. Then LyX invokes 
4137 \backslash
4138 build_command (with a default of``make'') to generate the code and 
4139 \backslash
4140 build_error_filter to process the compilation error messages.
4141 \begin_inset Newline newline
4142 \end_inset
4143
4144 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:
4145 \begin_inset Newline newline
4146 \end_inset
4147
4148
4149 \backslash
4150 build_command "my_script my_arguments"
4151 \begin_inset Newline newline
4152 \end_inset
4153
4154 The 
4155 \backslash
4156 build_error_filter differs from the 
4157 \backslash
4158 literate_error_filter only in that the former will identify error messages from your compiler.
4159 \end_layout
4160 \begin_layout Description
4161 Syntax build-program
4162 \end_layout
4163
4164 \begin_layout Subsection*
4165 LFUN_BUFFER_AUTO_SAVE
4166 \end_layout
4167 \begin_layout Description
4168 Action Saves the current buffer to a temporary file.
4169 \end_layout
4170 \begin_layout Description
4171 Notion Saves the current buffer to a file named "#filename#". This LFUN is called automatically by LyX, to "autosave" the current buffer.
4172 \end_layout
4173 \begin_layout Description
4174 Syntax buffer-auto-save
4175 \end_layout
4176
4177 \begin_layout Subsection*
4178 LFUN_BUFFER_CHILD_OPEN
4179 \end_layout
4180 \begin_layout Description
4181 Action Loads the given child document.
4182 \end_layout
4183 \begin_layout Description
4184 Notion The current document is treated as a parent.
4185 \end_layout
4186 \begin_layout Description
4187 Syntax buffer-child-open <FILE>
4188 \end_layout
4189 \begin_layout Description
4190 Params <FILE>: Filename of the child. The directory of the parent is assumed by default.
4191 \end_layout
4192 \begin_layout Description
4193 Origin Ale, 28 May 1997
4194 \end_layout
4195
4196 \begin_layout Subsection*
4197 LFUN_BUFFER_CHKTEX
4198 \end_layout
4199 \begin_layout Description
4200 Action Runs chktex for the current document.
4201 \end_layout
4202 \begin_layout Description
4203 Syntax buffer-chktex
4204 \end_layout
4205 \begin_layout Description
4206 Origin Asger, 30 Oct 1997
4207 \end_layout
4208
4209 \begin_layout Subsection*
4210 LFUN_BUFFER_TOGGLE_COMPRESSION
4211 \end_layout
4212 \begin_layout Description
4213 Action Toggles compression of the current document on/off.
4214 \end_layout
4215 \begin_layout Description
4216 Syntax buffer-toggle-compression
4217 \end_layout
4218 \begin_layout Description
4219 Origin bpeng, 27 Apr 2006
4220 \end_layout
4221
4222 \begin_layout Subsection*
4223 LFUN_BUFFER_CLOSE
4224 \end_layout
4225 \begin_layout Description
4226 Action Closes the current buffer.
4227 \end_layout
4228 \begin_layout Description
4229 Notion Closes the current buffer, asking whether to save it, etc, if the buffer has been modified.
4230 \end_layout
4231 \begin_layout Description
4232 Syntax buffer-close
4233 \end_layout
4234
4235 \begin_layout Subsection*
4236 LFUN_BUFFER_EXPORT
4237 \end_layout
4238 \begin_layout Description
4239 Action Exports the current buffer (document) to the given format.
4240 \end_layout
4241 \begin_layout Description
4242 Syntax buffer-export <FORMAT>
4243 \end_layout
4244 \begin_layout Description
4245 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.
4246 \begin_inset Newline newline
4247 \end_inset
4248
4249 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.
4250 \end_layout
4251 \begin_layout Description
4252 Origin Lgb, 29 Jul 1997
4253 \end_layout
4254
4255 \begin_layout Subsection*
4256 LFUN_BUFFER_EXPORT_CUSTOM
4257 \end_layout
4258 \begin_layout Description
4259 Action Exports the current buffer (document) from the given format using the given command on it.
4260 \end_layout
4261 \begin_layout Description
4262 Syntax buffer-export-custom <FORMAT> <COMMAND>
4263 \end_layout
4264 \begin_layout Description
4265 Params <FORMAT> format to start from (LyX will care to produce such intermediate file).
4266 \begin_inset Newline newline
4267 \end_inset
4268
4269 <COMMAND> this command will be launched on the file. Note that you can use "$$FName" string to qualify the intermediate file.
4270 \end_layout
4271 \begin_layout Description
4272 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
4273 \end_layout
4274 \begin_layout Description
4275 Origin leeming, 27 Mar 2004
4276 \end_layout
4277
4278 \begin_layout Subsection*
4279 LFUN_BUFFER_PRINT
4280 \end_layout
4281 \begin_layout Description
4282 Action Prints the current document.
4283 \end_layout
4284 \begin_layout Description
4285 Notion Many settings can be given via the preferences dialog.
4286 \end_layout
4287 \begin_layout Description
4288 Syntax buffer-print <TARGET> <TARGET-NAME> <COMMAND>
4289 \end_layout
4290 \begin_layout Description
4291 Params <TARGET> is either "printer" or "file".
4292 \begin_inset Newline newline
4293 \end_inset
4294
4295 <TARGER-NAME> is either "default" or file name or printer name.
4296 \begin_inset Newline newline
4297 \end_inset
4298
4299 <COMMAND> command ensuring the printing job.
4300 \end_layout
4301 \begin_layout Description
4302 Sample buffer-print file "/trash/newfile1.ps" "dvips"
4303 \end_layout
4304 \begin_layout Description
4305 Origin leeming, 28 Mar 2004
4306 \end_layout
4307
4308 \begin_layout Subsection*
4309 LFUN_BUFFER_IMPORT
4310 \end_layout
4311 \begin_layout Description
4312 Action Import a given file as a lyx document.
4313 \end_layout
4314 \begin_layout Description
4315 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.
4316 \end_layout
4317 \begin_layout Description
4318 Syntax buffer-import <FORMAT> [<FILE>]
4319 \end_layout
4320 \begin_layout Description
4321 Origin Asger, 24 Jul 1998
4322 \end_layout
4323
4324 \begin_layout Subsection*
4325 LFUN_BUFFER_NEW
4326 \end_layout
4327 \begin_layout Description
4328 Action Creates a new buffer (that is, document).
4329 \end_layout
4330 \begin_layout Description
4331 Notion Implicit path can be set in Preferences dialog.
4332 \end_layout
4333 \begin_layout Description
4334 Syntax buffer-new [<FILE>]
4335 \end_layout
4336 \begin_layout Description
4337 Params <FILE>: filename of created file with absolute path.
4338 \end_layout
4339
4340 \begin_layout Subsection*
4341 LFUN_BUFFER_NEW_TEMPLATE
4342 \end_layout
4343 \begin_layout Description
4344 Action Creates a new buffer (that is, document) from a template.
4345 \end_layout
4346 \begin_layout Description
4347 Notion Path for new files and templates can be set in Preferences dialog. Template will be asked for via Open-dialog.
4348 \end_layout
4349 \begin_layout Description
4350 Syntax buffer-new-template [<FILE>]
4351 \end_layout
4352 \begin_layout Description
4353 Params <FILE>: filename of created file with absolute path.
4354 \end_layout
4355
4356 \begin_layout Subsection*
4357 LFUN_BUFFER_RELOAD
4358 \end_layout
4359 \begin_layout Description
4360 Action Reverts opened document.
4361 \end_layout
4362 \begin_layout Description
4363 Syntax buffer-reload
4364 \end_layout
4365 \begin_layout Description
4366 Origin Asger, 2 Feb 1997
4367 \end_layout
4368
4369 \begin_layout Subsection*
4370 LFUN_BUFFER_SWITCH
4371 \end_layout
4372 \begin_layout Description
4373 Action Switch to the given buffer.
4374 \end_layout
4375 \begin_layout Description
4376 Notion This is useful also in case you need simultaneously more views of the edited document in different LyX windows.
4377 \end_layout
4378 \begin_layout Description
4379 Syntax buffer-new-template <BUFFER>
4380 \end_layout
4381 \begin_layout Description
4382 Params <BUFFER>: already opened document which is to be shown.
4383 \end_layout
4384
4385 \begin_layout Subsection*
4386 LFUN_BUFFER_TOGGLE_READ_ONLY
4387 \end_layout
4388 \begin_layout Description
4389 Action Toggle editing mode of the current document between read/write and read-only.
4390 \end_layout
4391 \begin_layout Description
4392 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.
4393 \begin_inset Newline newline
4394 \end_inset
4395
4396 If these operations fail, buffer won't be toggled.
4397 \end_layout
4398 \begin_layout Description
4399 Syntax buffer-toggle-read-only
4400 \end_layout
4401 \begin_layout Description
4402 Origin Lgb, 27 May 1997
4403 \end_layout
4404
4405 \begin_layout Subsection*
4406 LFUN_BUFFER_VIEW
4407 \end_layout
4408 \begin_layout Description
4409 Action Displays current buffer in chosen format.
4410 \end_layout
4411 \begin_layout Description
4412 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.
4413 \end_layout
4414 \begin_layout Description
4415 Syntax buffer-view [<FORMAT>]
4416 \end_layout
4417 \begin_layout Description
4418 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.
4419 \end_layout
4420
4421 \begin_layout Subsection*
4422 LFUN_BUFFER_UPDATE
4423 \end_layout
4424 \begin_layout Description
4425 Action Exports the current document and put the result into the temporary directory.
4426 \end_layout
4427 \begin_layout Description
4428 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).
4429 \end_layout
4430 \begin_layout Description
4431 Syntax buffer-update [<FORMAT>]
4432 \end_layout
4433 \begin_layout Description
4434 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.
4435 \end_layout
4436 \begin_layout Description
4437 Origin Dekel, 5 Aug 2000
4438 \end_layout
4439
4440 \begin_layout Subsection*
4441 LFUN_BUFFER_WRITE
4442 \end_layout
4443 \begin_layout Description
4444 Action Saves the current buffer.
4445 \end_layout
4446 \begin_layout Description
4447 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.
4448 \end_layout
4449 \begin_layout Description
4450 Syntax buffer-write
4451 \end_layout
4452
4453 \begin_layout Subsection*
4454 LFUN_BUFFER_WRITE_AS
4455 \end_layout
4456 \begin_layout Description
4457 Action Rename and save current buffer.
4458 \end_layout
4459 \begin_layout Description
4460 Syntax buffer-write-as <FILENAME>
4461 \end_layout
4462 \begin_layout Description
4463 Params <FILENAME>: New name of the buffer/file. A relative path is with respect to the original location of the buffer/file.
4464 \end_layout
4465
4466 \begin_layout Subsection*
4467 LFUN_BUFFER_WRITE_ALL
4468 \end_layout
4469 \begin_layout Description
4470 Action Save all changed documents.
4471 \end_layout
4472 \begin_layout Description
4473 Syntax buffer-write-all
4474 \end_layout
4475 \begin_layout Description
4476 Origin rgh, gpothier 6 Aug 2007
4477 \end_layout
4478
4479 \begin_layout Subsection*
4480 LFUN_BUFFER_NEXT
4481 \end_layout
4482 \begin_layout Description
4483 Action Switch to the next opened document.
4484 \end_layout
4485 \begin_layout Description
4486 Notion Note that this does not necessarily mean next in tabbar (for full list see View menu).
4487 \end_layout
4488 \begin_layout Description
4489 Syntax buffer-next
4490 \end_layout
4491
4492 \begin_layout Subsection*
4493 LFUN_BUFFER_PREVIOUS
4494 \end_layout
4495 \begin_layout Description
4496 Action Switch to the previous opened document.
4497 \end_layout
4498 \begin_layout Description
4499 Syntax buffer-previous
4500 \end_layout
4501
4502 \begin_layout Subsection*
4503 LFUN_MASTER_BUFFER_UPDATE
4504 \end_layout
4505 \begin_layout Description
4506 Action When run from a child document, this updates (exports) document built from the master buffer, if available.
4507 \end_layout
4508 \begin_layout Description
4509 Syntax master-buffer-update [<FORMAT>]
4510 \end_layout
4511 \begin_layout Description
4512 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.
4513 \end_layout
4514 \begin_layout Description
4515 Origin Tommaso, 20 Sep 2007
4516 \end_layout
4517
4518 \begin_layout Subsection*
4519 LFUN_MASTER_BUFFER_VIEW
4520 \end_layout
4521 \begin_layout Description
4522 Action When run from a child document, this command shows a preview built from the master buffer, if available.
4523 \end_layout
4524 \begin_layout Description
4525 Syntax master-buffer-view [<FORMAT>]
4526 \end_layout
4527 \begin_layout Description
4528 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.
4529 \end_layout
4530 \begin_layout Description
4531 Origin Tommaso, 20 Sep 2007
4532 \end_layout
4533
4534 \begin_layout Subsection*
4535 LFUN_BUFFER_LANGUAGE
4536 \end_layout
4537 \begin_layout Description
4538 Action Set language of the current document.
4539 \end_layout
4540 \begin_layout Description
4541 Syntax buffer-language <LANG>
4542 \end_layout
4543 \begin_layout Description
4544 Params <LANG>: language name. See lib/languages for list.
4545 \end_layout
4546 \begin_layout Description
4547 Origin leeming, 30 Mar 2004
4548 \end_layout
4549
4550 \begin_layout Subsection*
4551 LFUN_BUFFER_SAVE_AS_DEFAULT
4552 \end_layout
4553 \begin_layout Description
4554 Action Save the current document settings as default.
4555 \end_layout
4556 \begin_layout Description
4557 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
4558 \end_layout
4559 \begin_layout Description
4560 Syntax buffer-save-as-default [<ARGS>]
4561 \end_layout
4562 \begin_layout Description
4563 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
4564 \end_layout
4565 \begin_layout Description
4566 Origin leeming, 30 Mar 2004
4567 \end_layout
4568
4569 \begin_layout Subsection*
4570 LFUN_BUFFER_PARAMS_APPLY
4571 \end_layout
4572 \begin_layout Description
4573 Action Apply the given settings to the current document.
4574 \end_layout
4575 \begin_layout Description
4576 Syntax buffer-params-apply [<ARGS>]
4577 \end_layout
4578 \begin_layout Description
4579 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
4580 \end_layout
4581 \begin_layout Description
4582 Origin leeming, 30 Mar 2004
4583 \end_layout
4584
4585 \begin_layout Subsection*
4586 LFUN_FILE_INSERT
4587 \end_layout
4588 \begin_layout Description
4589 Action Inserts another LyX file.
4590 \end_layout
4591 \begin_layout Description
4592 Syntax file-insert [<FILE>]
4593 \end_layout
4594 \begin_layout Description
4595 Params <FILE>: Filename to be inserted.
4596 \end_layout
4597
4598 \begin_layout Subsection*
4599 LFUN_FILE_INSERT_PLAINTEXT
4600 \end_layout
4601 \begin_layout Description
4602 Action Inserts plain text file.
4603 \end_layout
4604 \begin_layout Description
4605 Syntax file-insert-plaintext [<FILE>]
4606 \end_layout
4607 \begin_layout Description
4608 Params <FILE>: Filename to be inserted.
4609 \end_layout
4610 \begin_layout Description
4611 Origin CFO-G, 19 Nov 1997
4612 \end_layout
4613
4614 \begin_layout Subsection*
4615 LFUN_FILE_INSERT_PLAINTEXT_PARA
4616 \end_layout
4617 \begin_layout Description
4618 Action Inserts plain text file as paragraph (i.e. join lines).
4619 \end_layout
4620 \begin_layout Description
4621 Syntax file-insert-plaintext-para [<FILE>]
4622 \end_layout
4623 \begin_layout Description
4624 Params <FILE>: Filename to be inserted.
4625 \end_layout
4626 \begin_layout Description
4627 Origin Levon, 14 Feb 2001
4628 \end_layout
4629
4630 \begin_layout Subsection*
4631 LFUN_FILE_OPEN
4632 \end_layout
4633 \begin_layout Description
4634 Action Open LyX document.
4635 \end_layout
4636 \begin_layout Description
4637 Syntax file-open [<FILE>]
4638 \end_layout
4639 \begin_layout Description
4640 Params <FILE>: Filename to be opened.
4641 \end_layout
4642
4643 \begin_layout Subsection*
4644 LFUN_CALL
4645 \end_layout
4646 \begin_layout Description
4647 Action Executes a command defined in a .def file.
4648 \end_layout
4649 \begin_layout Description
4650 Notion The definitions are by default read from lib/commands/default.def.
4651 \begin_inset Newline newline
4652 \end_inset
4653
4654 A .def file allows to define a command with 
4655 \backslash
4656 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). 
4657 \backslash
4658 def_file "FileName" allows to include another .def file.
4659 \begin_inset Newline newline
4660 \end_inset
4661
4662 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.
4663 \end_layout
4664 \begin_layout Description
4665 Syntax call <NAME>
4666 \end_layout
4667 \begin_layout Description
4668 Params <NAME>: Name of the command that must be called.
4669 \end_layout
4670 \begin_layout Description
4671 Origin broider, 2 Oct 2007
4672 \end_layout
4673
4674 \begin_layout Subsection*
4675 LFUN_META_PREFIX
4676 \end_layout
4677 \begin_layout Description
4678 Action Simulate halting Meta key (Alt key on PCs).
4679 \end_layout
4680 \begin_layout Description
4681 Notion Used for buffer editation not for GUI control.
4682 \end_layout
4683 \begin_layout Description
4684 Syntax meta-prefix
4685 \end_layout
4686
4687 \begin_layout Subsection*
4688 LFUN_CANCEL
4689 \end_layout
4690 \begin_layout Description
4691 Action Cancels sequence prepared by LFUN_META_PREFIX .
4692 \end_layout
4693 \begin_layout Description
4694 Syntax cancel
4695 \end_layout
4696
4697 \begin_layout Subsection*
4698 LFUN_COMMAND_EXECUTE
4699 \end_layout
4700 \begin_layout Description
4701 Action Opens the minibuffer toolbar so that the user can type in there.
4702 \end_layout
4703 \begin_layout Description
4704 Notion Usually bound to M-x shortcut.
4705 \end_layout
4706 \begin_layout Description
4707 Syntax command-execute
4708 \end_layout
4709
4710 \begin_layout Subsection*
4711 LFUN_COMMAND_PREFIX
4712 \end_layout
4713 \begin_layout Description
4714 Action Return the current key sequence and available options as a string.
4715 \end_layout
4716 \begin_layout Description
4717 Notion No options are added if no current map exists.
4718 \begin_inset Newline newline
4719 \end_inset
4720
4721 This is probably usable only with connection to lyxserver.
4722 \end_layout
4723 \begin_layout Description
4724 Syntax command-prefix
4725 \end_layout
4726
4727 \begin_layout Subsection*
4728 LFUN_COMMAND_SEQUENCE
4729 \end_layout
4730 \begin_layout Description
4731 Action Run more commands (LFUN and its parameters) in a sequence.
4732 \end_layout
4733 \begin_layout Description
4734 Syntax command-sequence <CMDS>
4735 \end_layout
4736 \begin_layout Description
4737 Params <CMDS>: Sequence of commands separated by semicolons.
4738 \end_layout
4739 \begin_layout Description
4740 Sample command-sequence cut; ert-insert; self-insert 
4741 \backslash
4742 ; paste; self-insert {}; inset-toggle;
4743 \end_layout
4744 \begin_layout Description
4745 Origin Andre, 11 Nov 1999
4746 \end_layout
4747
4748 \begin_layout Subsection*
4749 LFUN_COMMAND_ALTERNATIVES
4750 \end_layout
4751 \begin_layout Description
4752 Action Runs the first listed command that is enabled.
4753 \end_layout
4754 \begin_layout Description
4755 Notion This can be used to bind multiple functions to a single key, and then which one is used will depend upon the context.
4756 \end_layout
4757 \begin_layout Description
4758 Syntax command-alternatives <CMDS>
4759 \end_layout
4760 \begin_layout Description
4761 Params <CMDS>: Sequence of commands separated by semicolons.
4762 \end_layout
4763 \begin_layout Description
4764 Sample command-alternatives completion-accept;cell-forward
4765 \end_layout
4766 \begin_layout Description
4767 Origin rgh, 24 September 2008
4768 \end_layout
4769
4770 \begin_layout Subsection*
4771 LFUN_MESSAGE
4772 \end_layout
4773 \begin_layout Description
4774 Action Shows message in statusbar (for script purposes).
4775 \end_layout
4776 \begin_layout Description
4777 Syntax message <STRING>
4778 \end_layout
4779 \begin_layout Description
4780 Origin Lgb, 8 Apr 2001
4781 \end_layout
4782
4783 \begin_layout Subsection*
4784 LFUN_PREFERENCES_SAVE
4785 \end_layout
4786 \begin_layout Description
4787 Action Save user preferences.
4788 \end_layout
4789 \begin_layout Description
4790 Syntax preferences-save
4791 \end_layout
4792 \begin_layout Description
4793 Origin Lgb, 27 Nov 1999
4794 \end_layout
4795
4796 \begin_layout Subsection*
4797 LFUN_RECONFIGURE
4798 \end_layout
4799 \begin_layout Description
4800 Action Reconfigure the automatic settings.
4801 \end_layout
4802 \begin_layout Description
4803 Syntax reconfigure
4804 \end_layout
4805 \begin_layout Description
4806 Origin Asger, 14 Feb 1997
4807 \end_layout
4808
4809 \begin_layout Subsection*
4810 LFUN_LYXRC_APPLY
4811 \end_layout
4812 \begin_layout Description
4813 Action Apply the given settings to user preferences.
4814 \end_layout
4815 \begin_layout Description
4816 Syntax lyxrc-apply <SETTINGS>
4817 \end_layout
4818 \begin_layout Description
4819 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.
4820 \end_layout
4821
4822 \begin_layout Subsection*
4823 LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
4824 \end_layout
4825 \begin_layout Description
4826 Action Determine whether keep cursor inside the editing window regardless the scrollbar movement.
4827 \end_layout
4828 \begin_layout Description
4829 Syntax toggle-cursor-follows-scrollbar
4830 \end_layout
4831 \begin_layout Description
4832 Origin ARRae, 2 Dec 1997
4833 \end_layout
4834
4835 \begin_layout Subsection*
4836 LFUN_SET_COLOR
4837 \end_layout
4838 \begin_layout Description
4839 Action Set the given LyX color to the color defined by the X11 name given.
4840 \end_layout
4841 \begin_layout Description
4842 Notion A new color entry is created if the color is unknown. Color names can be stored as a part of user settings.
4843 \end_layout
4844 \begin_layout Description
4845 Syntax set-color <LYX_NAME> <X11_NAME>
4846 \end_layout
4847 \begin_layout Description
4848 Origin SLior, 11 Jun 2000
4849 \end_layout
4850
4851 \begin_layout Subsection*
4852 LFUN_STATISTICS
4853 \end_layout
4854 \begin_layout Description
4855 Action Count the statistics (number of words and characters) in the document or in the given selection.
4856 \end_layout
4857 \begin_layout Description
4858 Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
4859 \end_layout
4860 \begin_layout Description
4861 Syntax statistics
4862 \end_layout
4863 \begin_layout Description
4864 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
4865 \end_layout
4866
4867 \begin_layout Subsection*
4868 LFUN_COMPLETION_INLINE
4869 \end_layout
4870 \begin_layout Description
4871 Action Show the inline completion at the cursor position.
4872 \end_layout
4873 \begin_layout Description
4874 Syntax completion-inline
4875 \end_layout
4876 \begin_layout Description
4877 Origin sts, Feb 19 2008
4878 \end_layout
4879
4880 \begin_layout Subsection*
4881 LFUN_COMPLETION_POPUP
4882 \end_layout
4883 \begin_layout Description
4884 Action Show the completion popup at the cursor position.
4885 \end_layout
4886 \begin_layout Description
4887 Syntax completion-popup
4888 \end_layout
4889 \begin_layout Description
4890 Origin sts, Feb 19 2008
4891 \end_layout
4892
4893 \begin_layout Subsection*
4894 LFUN_COMPLETION_COMPLETE
4895 \end_layout
4896 \begin_layout Description
4897 Action Try to complete the word or command at the cursor position.
4898 \end_layout
4899 \begin_layout Description
4900 Syntax complete
4901 \end_layout
4902 \begin_layout Description
4903 Origin sts, Feb 19 2008
4904 \end_layout
4905
4906 \begin_layout Subsection*
4907 LFUN_COMPLETION_CANCEL
4908 \end_layout
4909 \begin_layout Description
4910 Action Try to cancel completion, either the popup or the inline completion
4911 \end_layout
4912 \begin_layout Description
4913 Syntax completion-cancel
4914 \end_layout
4915 \begin_layout Description
4916 Origin sts, Sep 07 2008
4917 \end_layout
4918
4919 \begin_layout Subsection*
4920 LFUN_COMPLETION_ACCEPT
4921 \end_layout
4922 \begin_layout Description
4923 Action Accept suggested completion.
4924 \end_layout
4925 \begin_layout Description
4926 Syntax completion-accept
4927 \end_layout
4928 \begin_layout Description
4929 Origin sanda, Sep 08 2008
4930 \end_layout
4931
4932 \begin_layout Subsection*
4933 LFUN_BRANCH_ACTIVATE
4934 \end_layout
4935 \begin_layout Description
4936 Action Activate the branch
4937 \end_layout
4938 \begin_layout Description
4939 Syntax branch-activate <BRANCH>
4940 \end_layout
4941 \begin_layout Description
4942 Params <BRANCH>: The branch to activate
4943 \end_layout
4944 \begin_layout Description
4945 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
4946 \begin_inset Newline newline
4947 \end_inset
4948
4949 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
4950 \end_layout
4951 \begin_layout Description
4952 Origin rgh, 27 May 2008
4953 \end_layout
4954
4955 \begin_layout Subsection*
4956 LFUN_BRANCH_DEACTIVATE
4957 \end_layout
4958 \begin_layout Description
4959 Action De-activate the branch
4960 \end_layout
4961 \begin_layout Description
4962 Syntax branch-deactivate <BRANCH>
4963 \end_layout
4964 \begin_layout Description
4965 Params <BRANCH>: The branch to deactivate
4966 \end_layout
4967 \begin_layout Description
4968 Origin rgh, 27 May 2008
4969 \end_layout
4970
4971 \begin_layout Subsection*
4972 LFUN_LABEL_COPY_AS_REF
4973 \end_layout
4974 \begin_layout Description
4975 Action Copies the label at the cursor as a cross-reference to be pasted elsewhere.
4976 \end_layout
4977 \begin_layout Description
4978 Syntax copy-label-as-reference
4979 \end_layout
4980 \begin_layout Description
4981 Origin sts, 16 Nov 2008
4982 \end_layout
4983
4984 \begin_layout Subsection*
4985 LFUN_LABEL_INSERT_AS_REF
4986 \end_layout
4987 \begin_layout Description
4988 Action Inserts the label as a cross-reference at the position of the cursor.
4989 \end_layout
4990 \begin_layout Description
4991 Syntax label-insert-as-reference
4992 \end_layout
4993 \begin_layout Description
4994 Origin vfr, 7 Apr 2009
4995 \end_layout
4996
4997 \begin_layout Subsection*
4998 LFUN_BUFFER_ZOOM_IN
4999 \end_layout
5000 \begin_layout Description
5001 Action Increases the zoom of the screen fonts.
5002 \end_layout
5003 \begin_layout Description
5004 Syntax buffer-zoom-in [<ZOOM>]
5005 \end_layout
5006 \begin_layout Description
5007 Params <ZOOM>: The zoom in %, the default is 20.
5008 \end_layout
5009 \begin_layout Description
5010 Origin vfr, 30 Mar 2009
5011 \end_layout
5012
5013 \begin_layout Subsection*
5014 LFUN_BUFFER_ZOOM_OUT
5015 \end_layout
5016 \begin_layout Description
5017 Action Decreases the zoom of the screen fonts.
5018 \end_layout
5019 \begin_layout Description
5020 Syntax buffer-zoom-out [<ZOOM>]
5021 \end_layout
5022 \begin_layout Description
5023 Params <ZOOM>: The zoom in %, the default is 20.
5024 \end_layout
5025 \begin_layout Description
5026 Origin vfr, 30 Mar 2009
5027 \end_layout
5028
5029 \begin_layout Subsection*
5030 LFUN_SECTION_SELECT
5031 \end_layout
5032 \begin_layout Description
5033 Action Selects the whole section.
5034 \end_layout
5035 \begin_layout Description
5036 Notion The cursor should be in a section heading before calling this lfun.
5037 \end_layout
5038 \begin_layout Description
5039 Syntax section-select
5040 \end_layout
5041 \begin_layout Description
5042 Origin vfr, 05 May 2009
5043 \end_layout
5044
5045 \end_body
5046 \end_document