lib/doc/LFUNs.lyx

   1 #LyX 1.6.0svn created this file. For more info see http://www.lyx.org/
   2 \lyxformat 344
   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 23.10.2008.
  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
  75 \begin_layout Subsection*
  76 LFUN_ACCENT_ACUTE
  77 \end_layout
  78
  79 \begin_layout Description
  80 Action Adds an acute accent to the next character typed.
  81
  82 \end_layout
  83
  84 \begin_layout Description
  85 Syntax accent-acute
  86 \end_layout
  87
  88 \begin_layout Subsection*
  89 LFUN_ACCENT_BREVE
  90 \end_layout
  91
  92 \begin_layout Description
  93 Action Adds a breve accent to the next character typed.
  94
  95 \end_layout
  96
  97 \begin_layout Description
  98 Syntax accent-breve
  99 \end_layout
 100
 101 \begin_layout Subsection*
 102 LFUN_ACCENT_CARON
 103 \end_layout
 104
 105 \begin_layout Description
 106 Action Adds a caron to the next character typed.
 107
 108 \end_layout
 109
 110 \begin_layout Description
 111 Syntax accent-caron
 112 \end_layout
 113
 114 \begin_layout Subsection*
 115 LFUN_ACCENT_CEDILLA
 116 \end_layout
 117
 118 \begin_layout Description
 119 Action Adds a cedilla to the next character typed.
 120
 121 \end_layout
 122
 123 \begin_layout Description
 124 Syntax accent-cedilla
 125 \end_layout
 126
 127 \begin_layout Subsection*
 128 LFUN_ACCENT_CIRCLE
 129 \end_layout
 130
 131 \begin_layout Description
 132 Action Adds a circle accent to the next character typed.
 133
 134 \end_layout
 135
 136 \begin_layout Description
 137 Syntax accent-circle
 138 \end_layout
 139
 140 \begin_layout Subsection*
 141 LFUN_ACCENT_CIRCUMFLEX
 142 \end_layout
 143
 144 \begin_layout Description
 145 Action Adds a circumflex to the next character typed.
 146
 147 \end_layout
 148
 149 \begin_layout Description
 150 Syntax accent-circumflex
 151 \end_layout
 152
 153 \begin_layout Subsection*
 154 LFUN_ACCENT_DOT
 155 \end_layout
 156
 157 \begin_layout Description
 158 Action Adds a dot accent to the next character typed.
 159
 160 \end_layout
 161
 162 \begin_layout Description
 163 Syntax accent-dot
 164 \end_layout
 165
 166 \begin_layout Subsection*
 167 LFUN_ACCENT_GRAVE
 168 \end_layout
 169
 170 \begin_layout Description
 171 Action Adds a grave accent to the next character typed.
 172
 173 \end_layout
 174
 175 \begin_layout Description
 176 Syntax accent-grave
 177 \end_layout
 178
 179 \begin_layout Subsection*
 180 LFUN_ACCENT_HUNGARIAN_UMLAUT
 181 \end_layout
 182
 183 \begin_layout Description
 184 Action Adds a Hungarian umlaut to the next character typed.
 185
 186 \end_layout
 187
 188 \begin_layout Description
 189 Syntax accent-grave
 190 \end_layout
 191
 192 \begin_layout Subsection*
 193 LFUN_ACCENT_MACRON
 194 \end_layout
 195
 196 \begin_layout Description
 197 Action Adds a macron to the next character typed.
 198
 199 \end_layout
 200
 201 \begin_layout Description
 202 Syntax accent-macron
 203 \end_layout
 204
 205 \begin_layout Subsection*
 206 LFUN_ACCENT_OGONEK
 207 \end_layout
 208
 209 \begin_layout Description
 210 Action Adds an ogonek accent to the next character typed.
 211
 212 \end_layout
 213
 214 \begin_layout Description
 215 Syntax accent-ogonek
 216 \end_layout
 217
 218 \begin_layout Subsection*
 219 LFUN_ACCENT_TIE
 220 \end_layout
 221
 222 \begin_layout Description
 223 Action Adds a tie over the next two character typed.
 224
 225 \end_layout
 226
 227 \begin_layout Description
 228 Notion The following char will finish the tie.
 229
 230 \end_layout
 231
 232 \begin_layout Description
 233 Syntax accent-tie
 234 \end_layout
 235
 236 \begin_layout Subsection*
 237 LFUN_ACCENT_TILDE
 238 \end_layout
 239
 240 \begin_layout Description
 241 Action Adds a tilde over the next character typed.
 242
 243 \end_layout
 244
 245 \begin_layout Description
 246 Syntax accent-tilde
 247 \end_layout
 248
 249 \begin_layout Subsection*
 250 LFUN_ACCENT_UMLAUT
 251 \end_layout
 252
 253 \begin_layout Description
 254 Action Adds an umlaut over the next character typed.
 255
 256 \end_layout
 257
 258 \begin_layout Description
 259 Syntax accent-umlaut
 260 \end_layout
 261
 262 \begin_layout Subsection*
 263 LFUN_ACCENT_UNDERBAR
 264 \end_layout
 265
 266 \begin_layout Description
 267 Action Adds a bar under the next character typed.
 268
 269 \end_layout
 270
 271 \begin_layout Description
 272 Syntax accent-underbar
 273 \end_layout
 274
 275 \begin_layout Subsection*
 276 LFUN_ACCENT_UNDERDOT
 277 \end_layout
 278
 279 \begin_layout Description
 280 Action Adds a dot under the next character typed.
 281
 282 \end_layout
 283
 284 \begin_layout Description
 285 Syntax accent-underdot
 286 \end_layout
 287
 288 \begin_layout Subsection*
 289 LFUN_CAPTION_INSERT
 290 \end_layout
 291
 292 \begin_layout Description
 293 Action Inserts a caption inset.
 294
 295 \end_layout
 296
 297 \begin_layout Description
 298 Syntax caption-insert
 299 \end_layout
 300
 301 \begin_layout Description
 302 Origin Lgb, 18 Jul 2000
 303 \end_layout
 304
 305 \begin_layout Subsection*
 306 LFUN_DATE_INSERT
 307 \end_layout
 308
 309 \begin_layout Description
 310 Action Inserts the current date.
 311
 312 \end_layout
 313
 314 \begin_layout Description
 315 Syntax date-insert [<ARG>]
 316 \end_layout
 317
 318 \begin_layout Description
 319 Params <ARG>: Format of date.
 320  The default value (%x) can be set in Preferences->Date format.
 321  For possible formats see manual page of strftime function.
 322
 323 \end_layout
 324
 325 \begin_layout Description
 326 Origin jdblair, 31 Jan 2000
 327 \end_layout
 328
 329 \begin_layout Subsection*
 330 LFUN_FOOTNOTE_INSERT
 331 \end_layout
 332
 333 \begin_layout Description
 334 Action Inserts a footnote inset.
 335
 336 \end_layout
 337
 338 \begin_layout Description
 339 Syntax footnote-insert
 340 \end_layout
 341
 342 \begin_layout Description
 343 Origin Jug, 7 Mar 2000
 344 \end_layout
 345
 346 \begin_layout Subsection*
 347 LFUN_ERT_INSERT
 348 \end_layout
 349
 350 \begin_layout Description
 351 Action Inserts an ERT inset.
 352
 353 \end_layout
 354
 355 \begin_layout Description
 356 Syntax ert-insert
 357 \end_layout
 358
 359 \begin_layout Description
 360 Origin Jug, 18 Feb 2000
 361 \end_layout
 362
 363 \begin_layout Subsection*
 364 LFUN_FLOAT_INSERT
 365 \end_layout
 366
 367 \begin_layout Description
 368 Action Inserts a float inset.
 369
 370 \end_layout
 371
 372 \begin_layout Description
 373 Syntax float-insert <TYPE>
 374 \end_layout
 375
 376 \begin_layout Description
 377 Params <TYPE>: type of float depends on the used textclass.
 378  Usually "algorithm", "table", "figure" parameters can be given.
 379
 380 \end_layout
 381
 382 \begin_layout Description
 383 Origin Lgb, 27 Jun 2000
 384 \end_layout
 385
 386 \begin_layout Subsection*
 387 LFUN_FLOAT_WIDE_INSERT
 388 \end_layout
 389
 390 \begin_layout Description
 391 Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
 392
 393 \end_layout
 394
 395 \begin_layout Description
 396 Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
 397
 398 \end_layout
 399
 400 \begin_layout Description
 401 Syntax float-wide-insert <TYPE>
 402 \end_layout
 403
 404 \begin_layout Description
 405 Params <TYPE>: type of float depends on the used textclass.
 406  Usually "algorithm", "table", "figure" parameters can be given.
 407
 408 \end_layout
 409
 410 \begin_layout Description
 411 Origin Lgb, 31 Oct 2001
 412 \end_layout
 413
 414 \begin_layout Subsection*
 415 LFUN_FLOAT_LIST_INSERT
 416 \end_layout
 417
 418 \begin_layout Description
 419 Action Inserts the list of floats in the document.
 420
 421 \end_layout
 422
 423 \begin_layout Description
 424 Syntax float-list-insert <TYPE>
 425 \end_layout
 426
 427 \begin_layout Description
 428 Params <TYPE>: type of float depends on the used textclass.
 429  Usually "algorithm", "table", "figure" parameters can be given.
 430
 431 \end_layout
 432
 433 \begin_layout Description
 434 Origin Lgb, 3 May 2001
 435 \end_layout
 436
 437 \begin_layout Subsection*
 438 LFUN_WRAP_INSERT
 439 \end_layout
 440
 441 \begin_layout Description
 442 Action Inserts floats wrapped by the text around.
 443
 444 \end_layout
 445
 446 \begin_layout Description
 447 Syntax wrap-insert <TYPE>
 448 \end_layout
 449
 450 \begin_layout Description
 451 Params <TYPE>: table|figure
 452 \end_layout
 453
 454 \begin_layout Description
 455 Origin Dekel, 7 Apr 2002
 456 \end_layout
 457
 458 \begin_layout Subsection*
 459 LFUN_OPTIONAL_INSERT
 460 \end_layout
 461
 462 \begin_layout Description
 463 Action Inserts an optional-argument (short title) inset.
 464
 465 \end_layout
 466
 467 \begin_layout Description
 468 Syntax optional-insert
 469 \end_layout
 470
 471 \begin_layout Description
 472 Origin vermeer, 12 Aug 2002
 473 \end_layout
 474
 475 \begin_layout Subsection*
 476 LFUN_LINE_INSERT
 477 \end_layout
 478
 479 \begin_layout Description
 480 Action Inserts a horizontal line.
 481
 482 \end_layout
 483
 484 \begin_layout Description
 485 Syntax line-insert
 486 \end_layout
 487
 488 \begin_layout Description
 489 Origin Andre, Oct 27 2003
 490 \end_layout
 491
 492 \begin_layout Subsection*
 493 LFUN_NEWPAGE_INSERT
 494 \end_layout
 495
 496 \begin_layout Description
 497 Action Inserts a new page.
 498
 499 \end_layout
 500
 501 \begin_layout Description
 502 Syntax newpage-insert <ARG>
 503 \end_layout
 504
 505 \begin_layout Description
 506 Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
 507
 508 \end_layout
 509
 510 \begin_layout Description
 511 Origin uwestoehr, 24 Nov 2007
 512 \end_layout
 513
 514 \begin_layout Subsection*
 515 LFUN_MARGINALNOTE_INSERT
 516 \end_layout
 517
 518 \begin_layout Description
 519 Action Inserts a marginal note.
 520
 521 \end_layout
 522
 523 \begin_layout Description
 524 Syntax marginalnote-insert
 525 \end_layout
 526
 527 \begin_layout Description
 528 Origin Lgb, 26 Jun 2000
 529 \end_layout
 530
 531 \begin_layout Subsection*
 532 LFUN_UNICODE_INSERT
 533 \end_layout
 534
 535 \begin_layout Description
 536 Action Inserts a single unicode character.
 537
 538 \end_layout
 539
 540 \begin_layout Description
 541 Syntax unicode-insert <CHAR>
 542 \end_layout
 543
 544 \begin_layout Description
 545 Params <CHAR>: The character to insert, given as its code point, in hexadecimal.
 546
 547 \end_layout
 548
 549 \begin_layout Description
 550 Sample unicode-insert 0x0100
 551 \end_layout
 552
 553 \begin_layout Description
 554 Origin Lgb, 22 Oct 2006
 555 \end_layout
 556
 557 \begin_layout Subsection*
 558 LFUN_LISTING_INSERT
 559 \end_layout
 560
 561 \begin_layout Description
 562 Action Inserts a new listings inset.
 563
 564 \end_layout
 565
 566 \begin_layout Description
 567 Syntax listing-insert
 568 \end_layout
 569
 570 \begin_layout Description
 571 Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
 572 \end_layout
 573
 574 \begin_layout Subsection*
 575 LFUN_TAB_INSERT
 576 \end_layout
 577
 578 \begin_layout Description
 579 Action Insert a tab into a listings inset.
 580
 581 \end_layout
 582
 583 \begin_layout Description
 584 Notion It also works on a selection.
 585
 586 \end_layout
 587
 588 \begin_layout Description
 589 Syntax tab-insert
 590 \end_layout
 591
 592 \begin_layout Description
 593 Origin vfvanravesteijn, Sep 30 2008
 594 \end_layout
 595
 596 \begin_layout Subsection*
 597 LFUN_TAB_DELETE
 598 \end_layout
 599
 600 \begin_layout Description
 601 Action Delete a tab or up to an equivalent amount of spaces from a listings
 602  inset.
 603
 604 \end_layout
 605
 606 \begin_layout Description
 607 Notion It also works on a selection - it removes a tab or spaces from the
 608  beginning of each line spanned by the selection.
 609  This is useful if you want to indent/unindent multiple lines in one action.
 610
 611 \end_layout
 612
 613 \begin_layout Description
 614 Syntax tab-delete
 615 \end_layout
 616
 617 \begin_layout Description
 618 Origin vfvanravesteijn, Sep 30 2008
 619 \end_layout
 620
 621 \begin_layout Subsection*
 622 LFUN_QUOTE_INSERT
 623 \end_layout
 624
 625 \begin_layout Description
 626 Action Inserts quotes according to the type and quote-language preference.
 627
 628 \end_layout
 629
 630 \begin_layout Description
 631 Action Currently  English, Swedish, German, Polish, French, Danish quotes
 632  are distinguished.
 633
 634 \end_layout
 635
 636 \begin_layout Description
 637 Syntax quote-insert [<TYPE>]
 638 \end_layout
 639
 640 \begin_layout Description
 641 Params <TYPE>: 'single' for single quotes, otherwise double quotes will
 642  be used.
 643
 644 \end_layout
 645
 646 \begin_layout Subsection*
 647 LFUN_INFO_INSERT
 648 \end_layout
 649
 650 \begin_layout Description
 651 Action Displays shortcuts, lyxrc, package and textclass availability and
 652  menu information in a non-editable boxed InsetText.
 653
 654 \end_layout
 655
 656 \begin_layout Description
 657 Notion Apart from lfun arguments you can use the following method:
 658 \begin_inset Newline newline
 659 \end_inset
 660
 661  1.
 662  input the type and argument of this inset, e.g.
 663  "menu paste", in the work area.
 664
 665 \begin_inset Newline newline
 666 \end_inset
 667
 668  2.
 669  select the text and run info-insert lfun.
 670
 671 \end_layout
 672
 673 \begin_layout Description
 674 Syntax info-insert <TYPE> <ARG>
 675 \end_layout
 676
 677 \begin_layout Description
 678 Params <TYPE>: shortcut|lyxrc|package|textclass|menu|buffer
 679 \begin_inset Newline newline
 680 \end_inset
 681
 682  <ARG>: argument for a given type.
 683  Look into InsetInfo.h for detailed description.
 684
 685 \end_layout
 686
 687 \begin_layout Description
 688 Origin bpeng, 7 Oct 2007
 689 \end_layout
 690
 691 \begin_layout Subsection*
 692 LFUN_BRANCH_INSERT
 693 \end_layout
 694
 695 \begin_layout Description
 696 Action Inserts branch inset.
 697
 698 \end_layout
 699
 700 \begin_layout Description
 701 Syntax branch-insert <BRANCH-NAME>
 702 \end_layout
 703
 704 \begin_layout Description
 705 Origin vermeer, 17 Aug 2003
 706 \end_layout
 707
 708 \begin_layout Subsection*
 709 LFUN_BOX_INSERT
 710 \end_layout
 711
 712 \begin_layout Description
 713 Action Inserts Box inset.
 714
 715 \end_layout
 716
 717 \begin_layout Description
 718 Syntax box-insert [<TYPE>]
 719 \end_layout
 720
 721 \begin_layout Description
 722 Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
 723
 724 \begin_inset Newline newline
 725 \end_inset
 726
 727  Framed is the default one.
 728
 729 \end_layout
 730
 731 \begin_layout Description
 732 Origin vermeer, 7 Oct 2003
 733 \end_layout
 734
 735 \begin_layout Subsection*
 736 LFUN_FLEX_INSERT
 737 \end_layout
 738
 739 \begin_layout Description
 740 Action Inserts CharStyle, Custom inset or XML short element.
 741
 742 \end_layout
 743
 744 \begin_layout Description
 745 Notion Look into the Customization manual for more information about these
 746  elements.
 747
 748 \begin_inset Newline newline
 749 \end_inset
 750
 751  To make this command enabled the layout file for the document class you're
 752  using has to load the character styles.
 753  There are a few contained in the Logical Markup module.
 754  You can also of course create some yourself.
 755
 756 \begin_inset Newline newline
 757 \end_inset
 758
 759  For dissolving the element see LFUN_INSET_DISSOLVE.
 760
 761 \end_layout
 762
 763 \begin_layout Description
 764 Syntax flex-insert <TYPE:Name>
 765 \end_layout
 766
 767 \begin_layout Description
 768 Params TYPE: CharStyle|Custom|Element|Standard
 769 \begin_inset Newline newline
 770 \end_inset
 771
 772  Identifies whether this is a Character Style, a Custom Inset or an XML
 773  Element, and which dynamical sub-menu this flex inset is in on the LyX
 774  menu tree.
 775  If Standard (currently unused): none of these.
 776  Name: This name must be defined either in your layout file or imported
 777  by some module.
 778  The definition is
 779 \begin_inset Newline newline
 780 \end_inset
 781
 782  InsetLayout <TYPE:Name>
 783 \end_layout
 784
 785 \begin_layout Description
 786 Sample flex-insert CharStyle:Code
 787 \end_layout
 788
 789 \begin_layout Subsection*
 790 LFUN_SELF_INSERT
 791 \end_layout
 792
 793 \begin_layout Description
 794 Action Inserts the given string (accordingly to the correct keymap).
 795
 796 \end_layout
 797
 798 \begin_layout Description
 799 Notion Automatically replace the currently selected text.
 800  Depends on lyxrc settings "auto_region_delete".
 801
 802 \end_layout
 803
 804 \begin_layout Description
 805 Syntax self-insert <STRING>
 806 \end_layout
 807
 808 \begin_layout Subsection*
 809 LFUN_SPACE_INSERT
 810 \end_layout
 811
 812 \begin_layout Description
 813 Action Inserts one of horizontal space insets.
 814
 815 \end_layout
 816
 817 \begin_layout Description
 818 Syntax space-insert <NAME> [<LEN>]
 819 \end_layout
 820
 821 \begin_layout Description
 822 Params <NAME>: normal, protected, thin, quad, qquad, enspace, enskip, negthinspa
 823 ce, hfill, hfill*, dotfill, hrulefill, hspace, hspace*
 824 \begin_inset Newline newline
 825 \end_inset
 826
 827  <LEN>: length for custom spaces (hspace, hspace* for protected)
 828 \end_layout
 829
 830 \begin_layout Description
 831 Origin JSpitzm, 20 May 2003, Mar 17 2008
 832 \end_layout
 833
 834 \begin_layout Subsection*
 835 LFUN_HYPERLINK_INSERT
 836 \end_layout
 837
 838 \begin_layout Description
 839 Action Inserts hyperlinks into the document (clickable in pdf output).
 840
 841 \end_layout
 842
 843 \begin_layout Description
 844 Notion Hyperlink target can be set via selection + hyperlink-insert function.
 845
 846 \end_layout
 847
 848 \begin_layout Description
 849 Syntax href-insert [<TARGET>]
 850 \end_layout
 851
 852 \begin_layout Description
 853 Origin CFO-G, 21 Nov 1997
 854 \end_layout
 855
 856 \begin_layout Subsection*
 857 LFUN_SPECIALCHAR_INSERT
 858 \end_layout
 859
 860 \begin_layout Description
 861 Action Inserts various characters into the document.
 862
 863 \end_layout
 864
 865 \begin_layout Description
 866 Syntax specialchar-insert <CHAR>
 867 \end_layout
 868
 869 \begin_layout Description
 870 Params <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots, end-of-sen
 871 tence, menu-separator.
 872
 873 \end_layout
 874
 875 \begin_layout Description
 876 Origin JSpitzm, 6 Dec 2007
 877 \end_layout
 878
 879 \begin_layout Subsection*
 880 LFUN_TOC_INSERT
 881 \end_layout
 882
 883 \begin_layout Description
 884 Action Inserts table of contents.
 885
 886 \end_layout
 887
 888 \begin_layout Description
 889 Syntax toc-insert
 890 \end_layout
 891
 892 \begin_layout Description
 893 Origin Lgb, 27 May 97
 894 \end_layout
 895
 896 \begin_layout Subsection*
 897 LFUN_APPENDIX
 898 \end_layout
 899
 900 \begin_layout Description
 901 Action Start (or remove) Appendix on the given cursor position.
 902
 903 \end_layout
 904
 905 \begin_layout Description
 906 Syntax appendix
 907 \end_layout
 908
 909 \begin_layout Description
 910 Origin ettrich, 5 May 1998
 911 \end_layout
 912
 913 \begin_layout Subsection*
 914 LFUN_INDEX_INSERT
 915 \end_layout
 916
 917 \begin_layout Description
 918 Action Inserts Index entry.
 919
 920 \end_layout
 921
 922 \begin_layout Description
 923 Notion It automatically takes the word on the cursor position.
 924
 925 \end_layout
 926
 927 \begin_layout Description
 928 Syntax index-insert
 929 \end_layout
 930
 931 \begin_layout Description
 932 Origin leeming, 3 Aug 2000
 933 \end_layout
 934
 935 \begin_layout Subsection*
 936 LFUN_INDEX_PRINT
 937 \end_layout
 938
 939 \begin_layout Description
 940 Action Inserts list of Index entries on a new page.
 941
 942 \end_layout
 943
 944 \begin_layout Description
 945 Syntax index-print
 946 \end_layout
 947
 948 \begin_layout Description
 949 Origin Lgb, 27 Feb 1997
 950 \end_layout
 951
 952 \begin_layout Subsection*
 953 LFUN_NOMENCL_INSERT
 954 \end_layout
 955
 956 \begin_layout Description
 957 Action Inserts Nomenclature entry.
 958
 959 \end_layout
 960
 961 \begin_layout Description
 962 Notion It automatically takes the word on the cursor position if no symbol
 963  is given.
 964
 965 \end_layout
 966
 967 \begin_layout Description
 968 Syntax nomencl-insert [<SYMBOL>]
 969 \end_layout
 970
 971 \begin_layout Description
 972 Origin Ugras, 4 Nov 2006
 973 \end_layout
 974
 975 \begin_layout Subsection*
 976 LFUN_NOMENCLATURE_PRINT
 977 \end_layout
 978
 979 \begin_layout Description
 980 Action Inserts list of Nomenclature entries.
 981
 982 \end_layout
 983
 984 \begin_layout Description
 985 Syntax nomenclature-print
 986 \end_layout
 987
 988 \begin_layout Description
 989 Origin Ugras, 4 Nov 2006
 990 \end_layout
 991
 992 \begin_layout Subsection*
 993 LFUN_NOTE_INSERT
 994 \end_layout
 995
 996 \begin_layout Description
 997 Action Inserts Note on the current cursor postion, move selection inside
 998  the inset.
 999
1000 \end_layout
1001
1002 \begin_layout Description
1003 Syntax note-insert [<TYPE>]
1004 \end_layout
1005
1006 \begin_layout Description
1007 Params <TYPE>: <Note|Greyedout|Comment> default: Note
1008 \end_layout
1009
1010 \begin_layout Subsection*
1011 LFUN_NOTE_NEXT
1012 \end_layout
1013
1014 \begin_layout Description
1015 Action Moves the cursor to the begining of next Note inset.
1016
1017 \end_layout
1018
1019 \begin_layout Description
1020 Syntax note-next
1021 \end_layout
1022
1023 \begin_layout Subsection*
1024 LFUN_NOTES_MUTATE
1025 \end_layout
1026
1027 \begin_layout Description
1028 Action Changes all Note insets of a particular type (source) to a different
1029  type (target) fot the current document.
1030
1031 \end_layout
1032
1033 \begin_layout Description
1034 Syntax notes-mutate <SOURCE> <TARGET>
1035 \end_layout
1036
1037 \begin_layout Description
1038 Params <SOURCE/TARGET>: Note|Comment|Greyedout
1039 \end_layout
1040
1041 \begin_layout Description
1042 Origin sanda, 18 Jun 2008
1043 \end_layout
1044
1045 \begin_layout Subsection*
1046 LFUN_NEWLINE_INSERT
1047 \end_layout
1048
1049 \begin_layout Description
1050 Action Inserts a line break or new line.
1051
1052 \end_layout
1053
1054 \begin_layout Description
1055 Syntax newline-insert [<ARG>]
1056 \end_layout
1057
1058 \begin_layout Description
1059 Params <ARG>: <newline|linebreak> default: newline
1060 \end_layout
1061
1062 \begin_layout Description
1063 Origin JSpitzm, 25 Mar 2008
1064 \end_layout
1065
1066 \begin_layout Subsection*
1067 LFUN_ESCAPE
1068 \end_layout
1069
1070 \begin_layout Description
1071 Action Clears the selection.
1072  If no text is selected call LFUN_FINISHED_FORWARD.
1073
1074 \end_layout
1075
1076 \begin_layout Description
1077 Syntax escape
1078 \end_layout
1079
1080 \begin_layout Description
1081 Origin Lgb, 17 May 2001
1082 \end_layout
1083
1084 \begin_layout Subsection*
1085 LFUN_DOWN
1086 \end_layout
1087
1088 \begin_layout Description
1089 Action Moves the cursor one line in downward direction.
1090
1091 \end_layout
1092
1093 \begin_layout Description
1094 Syntax down
1095 \end_layout
1096
1097 \begin_layout Subsection*
1098 LFUN_UP
1099 \end_layout
1100
1101 \begin_layout Description
1102 Action Moves the cursor one line in upward direction.
1103
1104 \end_layout
1105
1106 \begin_layout Description
1107 Syntax up
1108 \end_layout
1109
1110 \begin_layout Subsection*
1111 LFUN_DOWN_SELECT
1112 \end_layout
1113
1114 \begin_layout Description
1115 Action Moves the cursor one line in downward direction adding the current
1116  position to the selection.
1117
1118 \end_layout
1119
1120 \begin_layout Description
1121 Syntax down-select
1122 \end_layout
1123
1124 \begin_layout Subsection*
1125 LFUN_UP_SELECT
1126 \end_layout
1127
1128 \begin_layout Description
1129 Action Moves the cursor one line in upward direction adding the current
1130  position to the selection.
1131
1132 \end_layout
1133
1134 \begin_layout Description
1135 Syntax up-select
1136 \end_layout
1137
1138 \begin_layout Subsection*
1139 SCREEN_DOWN
1140 \end_layout
1141
1142 \begin_layout Description
1143 Action Moves the cursor one page in downward direction.
1144
1145 \end_layout
1146
1147 \begin_layout Description
1148 Syntax screen-down
1149 \end_layout
1150
1151 \begin_layout Subsection*
1152 LFUN_SCREEN_UP
1153 \end_layout
1154
1155 \begin_layout Description
1156 Action Moves the cursor one page in upward direction.
1157
1158 \end_layout
1159
1160 \begin_layout Description
1161 Syntax screen-up
1162 \end_layout
1163
1164 \begin_layout Subsection*
1165 LFUN_SCREEN_DOWN_SELECT
1166 \end_layout
1167
1168 \begin_layout Description
1169 Action Moves the cursor one screen in downward direction adding the current
1170  position to the selection.
1171
1172 \end_layout
1173
1174 \begin_layout Description
1175 Syntax screen-down-select
1176 \end_layout
1177
1178 \begin_layout Subsection*
1179 LFUN_SCREEN_UP_SELECT
1180 \end_layout
1181
1182 \begin_layout Description
1183 Action Moves the cursor one page in upward direction adding the current
1184  position to the selection.
1185
1186 \end_layout
1187
1188 \begin_layout Description
1189 Syntax screen-up-select
1190 \end_layout
1191
1192 \begin_layout Subsection*
1193 LFUN_SCROLL
1194 \end_layout
1195
1196 \begin_layout Description
1197 Action Scroll the buffer view.
1198
1199 \end_layout
1200
1201 \begin_layout Description
1202 Notion Only scrolls the screen up or down; does not move the cursor.
1203
1204 \end_layout
1205
1206 \begin_layout Description
1207 Syntax scroll <TYPE> <QUANTITY>
1208 \end_layout
1209
1210 \begin_layout Description
1211 Params <TYPE>:  line|page
1212 \begin_inset Newline newline
1213 \end_inset
1214
1215  <QUANTITY>: up|down|<number>
1216 \end_layout
1217
1218 \begin_layout Description
1219 Origin Abdel, Dec 27 2007
1220 \end_layout
1221
1222 \begin_layout Subsection*
1223 LFUN_SCREEN_RECENTER
1224 \end_layout
1225
1226 \begin_layout Description
1227 Action Recenters the screen on the current cursor position.
1228
1229 \end_layout
1230
1231 \begin_layout Description
1232 Syntax screen-recenter
1233 \end_layout
1234
1235 \begin_layout Subsection*
1236 LFUN_CHAR_BACKWARD
1237 \end_layout
1238
1239 \begin_layout Description
1240 Action Moves the cursor one position logically backwards.
1241
1242 \end_layout
1243
1244 \begin_layout Description
1245 Notion This is not the action which should be bound to the arrow keys, because
1246  backwards may be left or right, depending on the language.
1247  The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions,
1248  which in turn may employ this one.
1249
1250 \end_layout
1251
1252 \begin_layout Description
1253 Syntax char-backward
1254 \end_layout
1255
1256 \begin_layout Subsection*
1257 LFUN_CHAR_BACKWARD_SELECT
1258 \end_layout
1259
1260 \begin_layout Description
1261 Action Moves the cursor one position logically backwards, adding traversed
1262  position to the selection.
1263
1264 \end_layout
1265
1266 \begin_layout Description
1267 Notion See also LFUN_CHAR_BACKWARD.
1268
1269 \end_layout
1270
1271 \begin_layout Description
1272 Syntax char-backward-select
1273 \end_layout
1274
1275 \begin_layout Subsection*
1276 LFUN_CHAR_DELETE_BACKWARD
1277 \end_layout
1278
1279 \begin_layout Description
1280 Action Deletes one character in the backward direction (usually the "BackSpace"
1281  key).
1282
1283 \end_layout
1284
1285 \begin_layout Description
1286 Syntax char-delete-backward
1287 \end_layout
1288
1289 \begin_layout Subsection*
1290 LFUN_CHAR_DELETE_FORWARD
1291 \end_layout
1292
1293 \begin_layout Description
1294 Action Deletes one character in the backward direction (usually the "Delete"
1295  key).
1296
1297 \end_layout
1298
1299 \begin_layout Description
1300 Syntax char-delete-forward
1301 \end_layout
1302
1303 \begin_layout Subsection*
1304 LFUN_CHAR_FORWARD
1305 \end_layout
1306
1307 \begin_layout Description
1308 Action Moves the cursor one position logically forward.
1309
1310 \end_layout
1311
1312 \begin_layout Description
1313 Notion This is not the action which should be bound to the arrow keys, because
1314  forward may be left or right, depending on the language.
1315  The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions,
1316  which in turn may employ this one.
1317
1318 \end_layout
1319
1320 \begin_layout Description
1321 Syntax char-forward
1322 \end_layout
1323
1324 \begin_layout Subsection*
1325 LFUN_CHAR_FORWARD_SELECT
1326 \end_layout
1327
1328 \begin_layout Description
1329 Action Moves the cursor one position logically forward, adding traversed
1330  position to the selection.
1331
1332 \end_layout
1333
1334 \begin_layout Description
1335 Notion See also LFUN_CHAR_FORWARD.
1336
1337 \end_layout
1338
1339 \begin_layout Description
1340 Syntax char-forward-select
1341 \end_layout
1342
1343 \begin_layout Subsection*
1344 LFUN_CHAR_LEFT
1345 \end_layout
1346
1347 \begin_layout Description
1348 Action Moves the cursor one position "to the left".
1349
1350 \end_layout
1351
1352 \begin_layout Description
1353 Notion This is the action which should be taken when the "left" key is pressed.
1354  Generally, it moves the cursor one position to the left.
1355  However, in Bidi text this become slightly more complicated, and there
1356  are different modes of cursor movement.
1357  In "visual mode", this moves left, plain and simple.
1358  In "logical mode", movement is logically forward in RTL paragraphs, and
1359  logically backwards in LTR paragraphs.
1360
1361 \end_layout
1362
1363 \begin_layout Description
1364 Syntax char-left
1365 \end_layout
1366
1367 \begin_layout Subsection*
1368 LFUN_CHAR_LEFT_SELECT
1369 \end_layout
1370
1371 \begin_layout Description
1372 Action Moves the cursor one position "to the left", adding traversed position
1373  to the selection.
1374
1375 \end_layout
1376
1377 \begin_layout Description
1378 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1379
1380 \end_layout
1381
1382 \begin_layout Description
1383 Syntax char-left-select
1384 \end_layout
1385
1386 \begin_layout Subsection*
1387 LFUN_CHAR_RIGHT
1388 \end_layout
1389
1390 \begin_layout Description
1391 Action Moves the cursor one position "to the right".
1392
1393 \end_layout
1394
1395 \begin_layout Description
1396 Notion This is the action which should be taken when the "right" key is
1397  pressed.
1398  Generally, it moves the cursor one position to the right.
1399  However, in Bidi text this become slightly more complicated, and there
1400  are different modes of cursor movement.
1401  In "visual mode", this moves right, plain and simple.
1402  In "logical mode", movement is logically forward in LTR paragraphs, and
1403  logically backwards in RTL paragraphs.
1404
1405 \end_layout
1406
1407 \begin_layout Description
1408 Syntax char-right
1409 \end_layout
1410
1411 \begin_layout Subsection*
1412 LFUN_CHAR_RIGHT_SELECT
1413 \end_layout
1414
1415 \begin_layout Description
1416 Action Moves the cursor one position "to the right", adding traversed position
1417  to the selection.
1418
1419 \end_layout
1420
1421 \begin_layout Description
1422 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1423
1424 \end_layout
1425
1426 \begin_layout Description
1427 Syntax char-right-select
1428 \end_layout
1429
1430 \begin_layout Subsection*
1431 LFUN_WORD_BACKWARD
1432 \end_layout
1433
1434 \begin_layout Description
1435 Action Moves the cursor to the logically previous beginning of a word.
1436
1437 \end_layout
1438
1439 \begin_layout Description
1440 Notion This is not the action which should be bound to the arrow keys, because
1441  backwards may be left or right, depending on the language.
1442  The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
1443  which in turn may employ this one.
1444
1445 \end_layout
1446
1447 \begin_layout Description
1448 Syntax word-backward
1449 \end_layout
1450
1451 \begin_layout Subsection*
1452 LFUN_WORD_BACKWARD_SELECT
1453 \end_layout
1454
1455 \begin_layout Description
1456 Action Moves the cursor to the logically previous beginning of a word, adding
1457  the logically traversed text to the selection.
1458
1459 \end_layout
1460
1461 \begin_layout Description
1462 Notion See also LFUN_WORD_BACKWARD.
1463
1464 \end_layout
1465
1466 \begin_layout Description
1467 Syntax word-backward-select
1468 \end_layout
1469
1470 \begin_layout Subsection*
1471 LFUN_WORD_DELETE_BACKWARD
1472 \end_layout
1473
1474 \begin_layout Description
1475 Action Deletes characters to the begining of the word (usually the "C+BackSpace"
1476  key).
1477
1478 \end_layout
1479
1480 \begin_layout Description
1481 Syntax word-delete-backward
1482 \end_layout
1483
1484 \begin_layout Subsection*
1485 LFUN_WORD_DELETE_FORWARD
1486 \end_layout
1487
1488 \begin_layout Description
1489 Action Deletes characters to the end of the word (usually the "C+Delete"
1490  key).
1491
1492 \end_layout
1493
1494 \begin_layout Description
1495 Syntax word-delete-forward
1496 \end_layout
1497
1498 \begin_layout Subsection*
1499 LFUN_WORD_FIND_FORWARD
1500 \end_layout
1501
1502 \begin_layout Description
1503 Action Search for a given string in forward direction.
1504
1505 \end_layout
1506
1507 \begin_layout Description
1508 Notion Case sensitive, match words.
1509  If no argument given, last search repeated.
1510
1511 \end_layout
1512
1513 \begin_layout Description
1514 Syntax word-find-forward [<STRING>]
1515 \end_layout
1516
1517 \begin_layout Description
1518 Origin Etienne, 16 Feb 1998
1519 \end_layout
1520
1521 \begin_layout Subsection*
1522 LFUN_WORD_FIND_BACKWARD
1523 \end_layout
1524
1525 \begin_layout Description
1526 Action Search for a given string in backward direction.
1527
1528 \end_layout
1529
1530 \begin_layout Description
1531 Notion Case sensitive, match words.
1532  If no argument given, last search repeated.
1533
1534 \end_layout
1535
1536 \begin_layout Description
1537 Syntax word-find-backward [<STRING>]
1538 \end_layout
1539
1540 \begin_layout Description
1541 Origin Etienne, 20 Feb 1998
1542 \end_layout
1543
1544 \begin_layout Subsection*
1545 LFUN_WORD_FIND
1546 \end_layout
1547
1548 \begin_layout Description
1549 Action Search for next occurence of a string.
1550
1551 \end_layout
1552
1553 \begin_layout Description
1554 Syntax word-find [<DATA>]
1555 \end_layout
1556
1557 \begin_layout Description
1558 Params <DATA>: data encoded from Find dialog (see lyx::find2string()).
1559  If no parameter is given, search with last find-dialog data is used for
1560  search (i.e.
1561  find-next).
1562
1563 \end_layout
1564
1565 \begin_layout Description
1566 Origin Andre, Jan 7 2004
1567 \end_layout
1568
1569 \begin_layout Subsection*
1570 LFUN_WORD_REPLACE
1571 \end_layout
1572
1573 \begin_layout Description
1574 Action Replace a string in the document.
1575
1576 \end_layout
1577
1578 \begin_layout Description
1579 Syntax word-replace [<DATA>]
1580 \end_layout
1581
1582 \begin_layout Description
1583 Params <DATA>: data is of the form "<search>
1584 \begin_inset Newline newline
1585 \end_inset
1586
1587  <replace>
1588 \begin_inset Newline newline
1589 \end_inset
1590
1591  <casesensitive> <matchword> <all> <forward>"
1592 \end_layout
1593
1594 \begin_layout Description
1595 Origin Andre, Jan 7 2004
1596 \end_layout
1597
1598 \begin_layout Subsection*
1599 LFUN_WORD_FORWARD
1600 \end_layout
1601
1602 \begin_layout Description
1603 Action Moves the cursor to the logically next beginning of a word.
1604
1605 \end_layout
1606
1607 \begin_layout Description
1608 Notion This is not the action which should be bound to the arrow keys, because
1609  forward may be left or right, depending on the language.
1610  The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
1611  which in turn may employ this one.
1612
1613 \end_layout
1614
1615 \begin_layout Description
1616 Syntax word-forward
1617 \end_layout
1618
1619 \begin_layout Subsection*
1620 LFUN_WORD_FORWARD_SELECT
1621 \end_layout
1622
1623 \begin_layout Description
1624 Action Moves the cursor to the logically next beginning of a word, adding
1625  the logically traversed text to the selection.
1626
1627 \end_layout
1628
1629 \begin_layout Description
1630 Notion See also LFUN_WORD_FORWARD.
1631
1632 \end_layout
1633
1634 \begin_layout Description
1635 Syntax word-forward-select
1636 \end_layout
1637
1638 \begin_layout Subsection*
1639 LFUN_WORD_LEFT
1640 \end_layout
1641
1642 \begin_layout Description
1643 Action Moves the cursor to the next beginning of a word "on the left".
1644
1645 \end_layout
1646
1647 \begin_layout Description
1648 Notion This is the action which should be taken when the (e.g., ctrl-) "left"
1649  key is pressed.
1650  Generally, it moves the cursor to the next beginning of a word on the left.
1651  However, in Bidi text this become slightly more complicated, and there
1652  are different modes of cursor movement.
1653  In "visual mode", this moves left, plain and simple.
1654  In "logical mode", movement is logically forward in RTL paragraphs, and
1655  logically backwards in LTR paragraphs.
1656
1657 \end_layout
1658
1659 \begin_layout Description
1660 Syntax word-left
1661 \end_layout
1662
1663 \begin_layout Description
1664 Origin dov, 28 Oct 2007
1665 \end_layout
1666
1667 \begin_layout Subsection*
1668 LFUN_WORD_LEFT_SELECT
1669 \end_layout
1670
1671 \begin_layout Description
1672 Action Moves the cursor to the next beginning of a word "on the left", adding
1673  *logically* traversed text to the selection.
1674
1675 \end_layout
1676
1677 \begin_layout Description
1678 Notion See also LFUN_WORD_LEFT for exact details of the movement.
1679
1680 \end_layout
1681
1682 \begin_layout Description
1683 Syntax word-left-select
1684 \end_layout
1685
1686 \begin_layout Description
1687 Origin dov, 28 Oct 2007
1688 \end_layout
1689
1690 \begin_layout Subsection*
1691 LFUN_WORD_RIGHT
1692 \end_layout
1693
1694 \begin_layout Description
1695 Action Moves the cursor to the next beginning of a word "on the right".
1696
1697 \end_layout
1698
1699 \begin_layout Description
1700 Notion This is the action which should be taken when the (e.g., ctrl-) "right"
1701  key is pressed.
1702  Generally, it moves the cursor to the next beginning of a word on the right.
1703  However, in Bidi text this become slightly more complicated, and there
1704  are different modes of cursor movement.
1705  In "visual mode", this moves right, plain and simple.
1706  In "logical mode", movement is logically forward in LTR paragraphs, and
1707  logically backwards in RTL paragraphs.
1708
1709 \end_layout
1710
1711 \begin_layout Description
1712 Syntax word-right
1713 \end_layout
1714
1715 \begin_layout Description
1716 Origin dov, 28 Oct 2007
1717 \end_layout
1718
1719 \begin_layout Subsection*
1720 LFUN_WORD_RIGHT_SELECT
1721 \end_layout
1722
1723 \begin_layout Description
1724 Action Moves the cursor to the next beginning of a word "on the right",
1725  adding *logically* traversed text to the selection.
1726
1727 \end_layout
1728
1729 \begin_layout Description
1730 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
1731
1732 \end_layout
1733
1734 \begin_layout Description
1735 Syntax word-right-select
1736 \end_layout
1737
1738 \begin_layout Description
1739 Origin dov, 28 Oct 2007
1740 \end_layout
1741
1742 \begin_layout Subsection*
1743 LFUN_WORD_SELECT
1744 \end_layout
1745
1746 \begin_layout Description
1747 Action Puts the word where the cursor stands into the selection.
1748
1749 \end_layout
1750
1751 \begin_layout Description
1752 Syntax word-select
1753 \end_layout
1754
1755 \begin_layout Description
1756 Origin Andre, 11 Sep 2002
1757 \end_layout
1758
1759 \begin_layout Subsection*
1760 LFUN_WORD_CAPITALIZE
1761 \end_layout
1762
1763 \begin_layout Description
1764 Action Capitalizes the words in the selection (i.e.
1765  the first letters) or the letter on the cursor position.
1766
1767 \end_layout
1768
1769 \begin_layout Description
1770 Syntax word-capitalize
1771 \end_layout
1772
1773 \begin_layout Subsection*
1774 LFUN_WORD_UPCASE
1775 \end_layout
1776
1777 \begin_layout Description
1778 Action Change the words in the selection or from the cursor position to
1779  the end of word to the upper case.
1780
1781 \end_layout
1782
1783 \begin_layout Description
1784 Syntax word-upcase
1785 \end_layout
1786
1787 \begin_layout Subsection*
1788 LFUN_WORD_LOWCASE
1789 \end_layout
1790
1791 \begin_layout Description
1792 Action Change the words in the selection or from the cursor position to
1793  the end of word to the lower case.
1794
1795 \end_layout
1796
1797 \begin_layout Description
1798 Syntax word-lowcase
1799 \end_layout
1800
1801 \begin_layout Subsection*
1802 LFUN_THESAURUS_ENTRY
1803 \end_layout
1804
1805 \begin_layout Description
1806 Action Look up thesaurus entries with respect to the word under the cursor.
1807
1808 \end_layout
1809
1810 \begin_layout Description
1811 Syntax thesaurus-entry
1812 \end_layout
1813
1814 \begin_layout Description
1815 Origin Levon, 20 Jul 2001
1816 \end_layout
1817
1818 \begin_layout Subsection*
1819 LFUN_BUFFER_BEGIN
1820 \end_layout
1821
1822 \begin_layout Description
1823 Action Move the cursor to the beginning of the document.
1824
1825 \end_layout
1826
1827 \begin_layout Description
1828 Syntax buffer-begin
1829 \end_layout
1830
1831 \begin_layout Subsection*
1832 LFUN_BUFFER_BEGIN_SELECT
1833 \end_layout
1834
1835 \begin_layout Description
1836 Action Move the cursor to the beginning of the document adding the traversed
1837  text to the selection.
1838
1839 \end_layout
1840
1841 \begin_layout Description
1842 Syntax buffer-begin-select
1843 \end_layout
1844
1845 \begin_layout Subsection*
1846 LFUN_BUFFER_END
1847 \end_layout
1848
1849 \begin_layout Description
1850 Action Move the cursor to the end of the document.
1851
1852 \end_layout
1853
1854 \begin_layout Description
1855 Syntax buffer-end
1856 \end_layout
1857
1858 \begin_layout Subsection*
1859 LFUN_BUFFER_END_SELECT
1860 \end_layout
1861
1862 \begin_layout Description
1863 Action Move the cursor to the end of the document adding the traversed text
1864  to the selection.
1865
1866 \end_layout
1867
1868 \begin_layout Description
1869 Syntax buffer-end-select
1870 \end_layout
1871
1872 \begin_layout Subsection*
1873 LFUN_LINE_BEGIN
1874 \end_layout
1875
1876 \begin_layout Description
1877 Action Move the cursor to the begining of the (screen) line.
1878
1879 \end_layout
1880
1881 \begin_layout Description
1882 Syntax line-begin
1883 \end_layout
1884
1885 \begin_layout Subsection*
1886 LFUN_LINE_BEGIN_SELECT
1887 \end_layout
1888
1889 \begin_layout Description
1890 Action Move the cursor to the beginning of the (screen) line adding the
1891  traversed text to the selection.
1892
1893 \end_layout
1894
1895 \begin_layout Description
1896 Syntax line-begin-select
1897 \end_layout
1898
1899 \begin_layout Subsection*
1900 LFUN_LINE_END
1901 \end_layout
1902
1903 \begin_layout Description
1904 Action Move the cursor to the end of the (screen) line.
1905
1906 \end_layout
1907
1908 \begin_layout Description
1909 Syntax line-end
1910 \end_layout
1911
1912 \begin_layout Subsection*
1913 LFUN_LINE_END_SELECT
1914 \end_layout
1915
1916 \begin_layout Description
1917 Action Move the cursor to the end of the (screen) line adding the traversed
1918  text to the selection.
1919
1920 \end_layout
1921
1922 \begin_layout Description
1923 Syntax line-end-select
1924 \end_layout
1925
1926 \begin_layout Subsection*
1927 LFUN_LINE_DELETE
1928 \end_layout
1929
1930 \begin_layout Description
1931 Action Deletes the letters to the end of the (screen) line or deletes the
1932  selection.
1933
1934 \end_layout
1935
1936 \begin_layout Description
1937 Syntax line-delete-forward
1938 \end_layout
1939
1940 \begin_layout Subsection*
1941 LFUN_COPY
1942 \end_layout
1943
1944 \begin_layout Description
1945 Action Copies to the clipboard the last edit.
1946
1947 \end_layout
1948
1949 \begin_layout Description
1950 Syntax copy
1951 \end_layout
1952
1953 \begin_layout Subsection*
1954 LFUN_CUT
1955 \end_layout
1956
1957 \begin_layout Description
1958 Action Cuts to the clipboard.
1959
1960 \end_layout
1961
1962 \begin_layout Description
1963 Syntax cut
1964 \end_layout
1965
1966 \begin_layout Subsection*
1967 LFUN_PASTE
1968 \end_layout
1969
1970 \begin_layout Description
1971 Action Pastes material from the active clipboard.
1972
1973 \end_layout
1974
1975 \begin_layout Description
1976 Syntax paste [<TYPE>]
1977 \end_layout
1978
1979 \begin_layout Description
1980 Params <TYPE>: pdf|png|jpeg|linkback
1981 \end_layout
1982
1983 \begin_layout Subsection*
1984 LFUN_CLIPBOARD_PASTE
1985 \end_layout
1986
1987 \begin_layout Description
1988 Action Pastes text from the active clipboard.
1989
1990 \end_layout
1991
1992 \begin_layout Description
1993 Syntax clipboard-paste [<ARG>]
1994 \end_layout
1995
1996 \begin_layout Description
1997 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
1998  "Join lines".
1999
2000 \end_layout
2001
2002 \begin_layout Description
2003 Origin baum, 10 Jul 2006
2004 \end_layout
2005
2006 \begin_layout Subsection*
2007 LFUN_PRIMARY_SELECTION_PASTE
2008 \end_layout
2009
2010 \begin_layout Description
2011 Action Pastes the currently text selected text.
2012
2013 \end_layout
2014
2015 \begin_layout Description
2016 Notion Primary selection mechanism is linux-only thing.
2017
2018 \end_layout
2019
2020 \begin_layout Description
2021 Syntax primary-selection-paste [<ARG>]
2022 \end_layout
2023
2024 \begin_layout Description
2025 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
2026  "Join lines".
2027
2028 \end_layout
2029
2030 \begin_layout Subsection*
2031 LFUN_UNDO
2032 \end_layout
2033
2034 \begin_layout Description
2035 Action Undoes the last edit.
2036
2037 \end_layout
2038
2039 \begin_layout Description
2040 Syntax undo
2041 \end_layout
2042
2043 \begin_layout Subsection*
2044 LFUN_REDO
2045 \end_layout
2046
2047 \begin_layout Description
2048 Action Redoes the last thing undone.
2049
2050 \end_layout
2051
2052 \begin_layout Description
2053 Syntax redo
2054 \end_layout
2055
2056 \begin_layout Subsection*
2057 LFUN_REPEAT
2058 \end_layout
2059
2060 \begin_layout Description
2061 Action Repeat the given command.
2062
2063 \end_layout
2064
2065 \begin_layout Description
2066 Syntax repeat <COUNT> <LFUN-COMMAND>
2067 \end_layout
2068
2069 \begin_layout Description
2070 Origin Andre, , 27 Oct 2003
2071 \end_layout
2072
2073 \begin_layout Subsection*
2074 LFUN_CHARS_TRANSPOSE
2075 \end_layout
2076
2077 \begin_layout Description
2078 Action Transposes the character at the cursor with the one before it.
2079
2080 \end_layout
2081
2082 \begin_layout Description
2083 Syntax chars-transpose
2084 \end_layout
2085
2086 \begin_layout Description
2087 Origin Lgb, 25 Apr 2001
2088 \end_layout
2089
2090 \begin_layout Subsection*
2091 LFUN_DEPTH_DECREMENT
2092 \end_layout
2093
2094 \begin_layout Description
2095 Action Decrease the nesting depth of the (selected) paragraph(s) inside
2096  lists.
2097
2098 \end_layout
2099
2100 \begin_layout Description
2101 Syntax depth-decrement
2102 \end_layout
2103
2104 \begin_layout Subsection*
2105 LFUN_DEPTH_INCREMENT
2106 \end_layout
2107
2108 \begin_layout Description
2109 Action Increase the nesting depth of the (selected) paragraph(s) inside
2110  lists.
2111
2112 \end_layout
2113
2114 \begin_layout Description
2115 Syntax depth-increment
2116 \end_layout
2117
2118 \begin_layout Subsection*
2119 LFUN_FONT_BOLD
2120 \end_layout
2121
2122 \begin_layout Description
2123 Action Toggles the bold font (selection-wise) using mathbf in math.
2124
2125 \end_layout
2126
2127 \begin_layout Description
2128 Syntax font-bold
2129 \end_layout
2130
2131 \begin_layout Subsection*
2132 LFUN_FONT_BOLDSYMBOL
2133 \end_layout
2134
2135 \begin_layout Description
2136 Action Toggles the bold font (selection-wise) using boldsymbol in math.
2137
2138 \end_layout
2139
2140 \begin_layout Description
2141 Syntax font-boldsymbol
2142 \end_layout
2143
2144 \begin_layout Subsection*
2145 LFUN_FONT_TYPEWRITER
2146 \end_layout
2147
2148 \begin_layout Description
2149 Action Toggles the typewriter family font (selection-wise).
2150
2151 \end_layout
2152
2153 \begin_layout Description
2154 Syntax font-typewriter
2155 \end_layout
2156
2157 \begin_layout Subsection*
2158 LFUN_FONT_UNDERLINE
2159 \end_layout
2160
2161 \begin_layout Description
2162 Action Toggles underline in the font (selection-wise).
2163
2164 \end_layout
2165
2166 \begin_layout Description
2167 Syntax font-underline
2168 \end_layout
2169
2170 \begin_layout Subsection*
2171 LFUN_FONT_EMPH
2172 \end_layout
2173
2174 \begin_layout Description
2175 Action Toggles the emphasis font style (selection-wise).
2176
2177 \end_layout
2178
2179 \begin_layout Description
2180 Syntax font-emph
2181 \end_layout
2182
2183 \begin_layout Subsection*
2184 LFUN_FONT_NOUN
2185 \end_layout
2186
2187 \begin_layout Description
2188 Action Toggles Noun text style font (selection-wise).
2189
2190 \end_layout
2191
2192 \begin_layout Description
2193 Syntax font-noun
2194 \end_layout
2195
2196 \begin_layout Subsection*
2197 LFUN_FONT_ROMAN
2198 \end_layout
2199
2200 \begin_layout Description
2201 Action Toggles Roman family font (selection-wise).
2202
2203 \end_layout
2204
2205 \begin_layout Description
2206 Syntax font-roman
2207 \end_layout
2208
2209 \begin_layout Subsection*
2210 LFUN_FONT_SANS
2211 \end_layout
2212
2213 \begin_layout Description
2214 Action Toggles Sans Serif family font (selection-wise).
2215
2216 \end_layout
2217
2218 \begin_layout Description
2219 Syntax font-sans
2220 \end_layout
2221
2222 \begin_layout Subsection*
2223 LFUN_FONT_FRAK
2224 \end_layout
2225
2226 \begin_layout Description
2227 Action Toggles Fraktur family font (math-mode, selection-wise).
2228
2229 \end_layout
2230
2231 \begin_layout Description
2232 Syntax font-frak
2233 \end_layout
2234
2235 \begin_layout Description
2236 Origin vermeer, 10 Jan 2002
2237 \end_layout
2238
2239 \begin_layout Subsection*
2240 LFUN_FONT_ITAL
2241 \end_layout
2242
2243 \begin_layout Description
2244 Action Toggles Italics font shape (math-mode, selection-wise).
2245
2246 \end_layout
2247
2248 \begin_layout Description
2249 Syntax font-ital
2250 \end_layout
2251
2252 \begin_layout Description
2253 Origin vermeer, 10 Jan 2002
2254 \end_layout
2255
2256 \begin_layout Subsection*
2257 LFUN_FONT_DEFAULT
2258 \end_layout
2259
2260 \begin_layout Description
2261 Action Reverts the settings of the font to the default values (selection-wise).
2262
2263 \end_layout
2264
2265 \begin_layout Description
2266 Syntax font-default
2267 \end_layout
2268
2269 \begin_layout Subsection*
2270 LFUN_FONT_SIZE
2271 \end_layout
2272
2273 \begin_layout Description
2274 Action Sets font size according to lyx format string.
2275
2276 \end_layout
2277
2278 \begin_layout Description
2279 Syntax font-size <SIZE>
2280 \end_layout
2281
2282 \begin_layout Description
2283 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
2284 \begin_inset Newline newline
2285 \end_inset
2286
2287  largest|huge|giant|increase|decrease|default
2288 \end_layout
2289
2290 \begin_layout Subsection*
2291 LFUN_TEXTSTYLE_APPLY
2292 \end_layout
2293
2294 \begin_layout Description
2295 Action Toggle user-defined (=last-time used) text style.
2296
2297 \end_layout
2298
2299 \begin_layout Description
2300 Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically
2301  trigerred when using Text Style dialog.
2302
2303 \end_layout
2304
2305 \begin_layout Description
2306 Syntax textstyle-apply
2307 \end_layout
2308
2309 \begin_layout Description
2310 Origin leeming, 12 Mar 2003
2311 \end_layout
2312
2313 \begin_layout Subsection*
2314 LFUN_TEXTSTYLE_UPDATE
2315 \end_layout
2316
2317 \begin_layout Description
2318 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APP
2319 LY.
2320
2321 \end_layout
2322
2323 \begin_layout Description
2324 Syntax textstyle-update <FONT_INFO>
2325 \end_layout
2326
2327 \begin_layout Description
2328 Params <FONT_INFO>: specifies font atributes, e.g.
2329  family, series, shape, size, emph, noun, underbar, number, color, language,
2330  toggleall.
2331
2332 \begin_inset Newline newline
2333 \end_inset
2334
2335  Use lyx -dbg action for exact syntax of text-style dialog parameters.
2336
2337 \end_layout
2338
2339 \begin_layout Description
2340 Origin leeming, 12 Mar 2003
2341 \end_layout
2342
2343 \begin_layout Subsection*
2344 LFUN_SCREEN_FONT_UPDATE
2345 \end_layout
2346
2347 \begin_layout Description
2348 Action Update fonts and its metrics.
2349
2350 \end_layout
2351
2352 \begin_layout Description
2353 Notion Automatically called after zoom, dpi, font names, or norm change.
2354
2355 \end_layout
2356
2357 \begin_layout Description
2358 Syntax screen-font-update
2359 \end_layout
2360
2361 \begin_layout Description
2362 Origin ARRae, 13 Aug 2000
2363 \end_layout
2364
2365 \begin_layout Subsection*
2366 LFUN_FONT_STATE
2367 \end_layout
2368
2369 \begin_layout Description
2370 Action Returns the info about the current font.
2371
2372 \end_layout
2373
2374 \begin_layout Description
2375 Syntax font-state
2376 \end_layout
2377
2378 \begin_layout Subsection*
2379 LFUN_CITATION_INSERT
2380 \end_layout
2381
2382 \begin_layout Description
2383 Action Inserts citation from loaded citation database.
2384
2385 \end_layout
2386
2387 \begin_layout Description
2388 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
2389 \end_layout
2390
2391 \begin_layout Description
2392 Params <KEY>: Citation (shortcut listed in available citations).
2393
2394 \begin_inset Newline newline
2395 \end_inset
2396
2397  <TEXT_BEFORE>: text which should appear before citation.
2398
2399 \end_layout
2400
2401 \begin_layout Description
2402 Origin AAS, 97-02-23
2403 \end_layout
2404
2405 \begin_layout Subsection*
2406 LFUN_BIBTEX_DATABASE_ADD
2407 \end_layout
2408
2409 \begin_layout Description
2410 Action Adds database, which will be used for bibtex citations.
2411
2412 \end_layout
2413
2414 \begin_layout Description
2415 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX
2416  bibliography) found from the cursor postion.
2417
2418 \end_layout
2419
2420 \begin_layout Description
2421 Syntax bibtex-database-add <DATABASE-NAME>
2422 \end_layout
2423
2424 \begin_layout Description
2425 Origin Ale, 30 May 1997
2426 \end_layout
2427
2428 \begin_layout Subsection*
2429 LFUN_BIBTEX_DATABASE_DEL
2430 \end_layout
2431
2432 \begin_layout Description
2433 Action Adds database, which will be used for bibtex citations.
2434
2435 \end_layout
2436
2437 \begin_layout Description
2438 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTe
2439 X bibliography) found from the cursor postion.
2440
2441 \end_layout
2442
2443 \begin_layout Description
2444 Syntax bibtex-database-del <DATABASE-NAME>
2445 \end_layout
2446
2447 \begin_layout Description
2448 Origin Ale, 30 May 1997
2449 \end_layout
2450
2451 \begin_layout Subsection*
2452 LFUN_LAYOUT
2453 \end_layout
2454
2455 \begin_layout Description
2456 Action Sets the layout (that is, environment) for the current paragraph.
2457
2458 \end_layout
2459
2460 \begin_layout Description
2461 Syntax layout <LAYOUT>
2462 \end_layout
2463
2464 \begin_layout Description
2465 Params <LAYOUT>: the layout to use
2466 \end_layout
2467
2468 \begin_layout Subsection*
2469 LFUN_LAYOUT_PARAGRAPH
2470 \end_layout
2471
2472 \begin_layout Description
2473 Action Launches the paragraph settings dialog.
2474
2475 \end_layout
2476
2477 \begin_layout Description
2478 Syntax layout-paragraph
2479 \end_layout
2480
2481 \begin_layout Subsection*
2482 LFUN_LAYOUT_TABULAR
2483 \end_layout
2484
2485 \begin_layout Description
2486 Action Launches the tabular settings dialog.
2487
2488 \end_layout
2489
2490 \begin_layout Description
2491 Syntax layout-tabular
2492 \end_layout
2493
2494 \begin_layout Description
2495 Origin Jug, 31 Jul 2000
2496 \end_layout
2497
2498 \begin_layout Subsection*
2499 LFUN_DROP_LAYOUTS_CHOICE
2500 \end_layout
2501
2502 \begin_layout Description
2503 Action Displays list of layout choices.
2504
2505 \end_layout
2506
2507 \begin_layout Description
2508 Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox
2509  allowing for choice of layout.
2510
2511 \end_layout
2512
2513 \begin_layout Description
2514 Syntax drop-layouts-choice
2515 \end_layout
2516
2517 \begin_layout Subsection*
2518 LFUN_LAYOUT_MODULES_CLEAR
2519 \end_layout
2520
2521 \begin_layout Description
2522 Action Clears the module list.
2523
2524 \end_layout
2525
2526 \begin_layout Description
2527 Notion Clears the list of included modules for the current buffer.
2528
2529 \end_layout
2530
2531 \begin_layout Description
2532 Syntax layout-modules-clear
2533 \end_layout
2534
2535 \begin_layout Description
2536 Origin rgh, 25 August 2007
2537 \end_layout
2538
2539 \begin_layout Subsection*
2540 LFUN_LAYOUT_MODULE_ADD
2541 \end_layout
2542
2543 \begin_layout Description
2544 Action Adds a module.
2545
2546 \end_layout
2547
2548 \begin_layout Description
2549 Notion Adds a module to the list of included modules for the current buffer.
2550
2551 \end_layout
2552
2553 \begin_layout Description
2554 Syntax layout-module-add <MODULE>
2555 \end_layout
2556
2557 \begin_layout Description
2558 Params <MODULE>: the module to be added
2559 \end_layout
2560
2561 \begin_layout Description
2562 Origin rgh, 25 August 2007
2563 \end_layout
2564
2565 \begin_layout Subsection*
2566 LFUN_LAYOUT_RELOAD
2567 \end_layout
2568
2569 \begin_layout Description
2570 Action Reloads layout information.
2571
2572 \end_layout
2573
2574 \begin_layout Description
2575 Notion Reloads all layout information for the current buffer from disk,
2576  thus recognizing any changes that have been made to layout files on the
2577  fly.
2578  This is intended to be used only by layout developers and should not be
2579  used when one is trying to do actual work.
2580
2581 \end_layout
2582
2583 \begin_layout Description
2584 Syntax layout-reload
2585 \end_layout
2586
2587 \begin_layout Description
2588 Origin rgh, 3 September 2007
2589 \end_layout
2590
2591 \begin_layout Subsection*
2592 LFUN_TEXTCLASS_APPLY
2593 \end_layout
2594
2595 \begin_layout Description
2596 Action Sets the text class for the current buffer.
2597
2598 \end_layout
2599
2600 \begin_layout Description
2601 Syntax textclass-apply <TEXTCLASS>
2602 \end_layout
2603
2604 \begin_layout Description
2605 Params <TEXTCLASS>: the textclass to set.
2606  Note that this must be the filename, minus the ".layout" extension.
2607
2608 \end_layout
2609
2610 \begin_layout Subsection*
2611 LFUN_TEXTCLASS_LOAD
2612 \end_layout
2613
2614 \begin_layout Description
2615 Action Loads information for a textclass from disk.
2616
2617 \end_layout
2618
2619 \begin_layout Description
2620 Syntax textclass-load <TEXTCLASS>
2621 \end_layout
2622
2623 \begin_layout Description
2624 Params <TEXTCLASS>: the textclass to load.
2625  Note that this must be the filename, minus the ".layout" extension.
2626
2627 \end_layout
2628
2629 \begin_layout Subsection*
2630 LFUN_MARK_OFF
2631 \end_layout
2632
2633 \begin_layout Description
2634 Action Disable selecting of text-region.
2635
2636 \end_layout
2637
2638 \begin_layout Description
2639 Syntax mark-off
2640 \end_layout
2641
2642 \begin_layout Subsection*
2643 LFUN_MARK_ON
2644 \end_layout
2645
2646 \begin_layout Description
2647 Action Enable selecting of text-region.
2648
2649 \end_layout
2650
2651 \begin_layout Description
2652 Notion After enabling you can simply move arrow keys to get selected region.
2653
2654 \end_layout
2655
2656 \begin_layout Description
2657 Syntax mark-on
2658 \end_layout
2659
2660 \begin_layout Subsection*
2661 LFUN_MARK_TOGGLE
2662 \end_layout
2663
2664 \begin_layout Description
2665 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
2666
2667 \end_layout
2668
2669 \begin_layout Description
2670 Syntax mark-toggle
2671 \end_layout
2672
2673 \begin_layout Description
2674 Origin Andre, May 5 2006
2675 \end_layout
2676
2677 \begin_layout Subsection*
2678 LFUN_MATH_DELIM
2679 \end_layout
2680
2681 \begin_layout Description
2682 Action Inserts math delimiters (e.g.
2683  parentheses, brackets) enclosing expression.
2684
2685 \end_layout
2686
2687 \begin_layout Description
2688 Syntax math-delim [<LEFT>] [<RIGHT>]
2689 \end_layout
2690
2691 \begin_layout Description
2692 Params <LEFT/RIGHT>: Delimiters to be used.
2693  Each delimiter can be specified by either a LaTeX name or a valid character.
2694  ( is the default letter.
2695
2696 \end_layout
2697
2698 \begin_layout Description
2699 Sample math-delim { rangle
2700 \end_layout
2701
2702 \begin_layout Description
2703 Origin Alejandro, 18 Jun 1996
2704 \end_layout
2705
2706 \begin_layout Subsection*
2707 LFUN_MATH_BIGDELIM
2708 \end_layout
2709
2710 \begin_layout Description
2711 Action Inserts math fixed size delimiters (e.g.
2712  parentheses, brackets) enclosing expression.
2713
2714 \end_layout
2715
2716 \begin_layout Description
2717 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
2718 \end_layout
2719
2720 \begin_layout Description
2721 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
2722 \begin_inset Newline newline
2723 \end_inset
2724
2725  <L/RDELIM>: TeX code for delimiter.
2726  See Delimiter dialog for delimiters to be used.
2727
2728 \end_layout
2729
2730 \begin_layout Description
2731 Sample math-bigdelim "Bigl" "Downarrow" "Bigr" "}"
2732 \end_layout
2733
2734 \begin_layout Description
2735 Origin Enrico & Georg, 7 May 2006
2736 \end_layout
2737
2738 \begin_layout Subsection*
2739 LFUN_MATH_DISPLAY
2740 \end_layout
2741
2742 \begin_layout Description
2743 Action Creates a new displayed equation in text mode.
2744  Toggles inlined/display formula in math mode.
2745
2746 \end_layout
2747
2748 \begin_layout Description
2749 Syntax math-display [<ARG>]
2750 \end_layout
2751
2752 \begin_layout Description
2753 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating
2754  new equation from the text mode.
2755
2756 \end_layout
2757
2758 \begin_layout Description
2759 Origin Alejandro, 18 Jun 1996
2760 \end_layout
2761
2762 \begin_layout Subsection*
2763 LFUN_MATH_INSERT
2764 \end_layout
2765
2766 \begin_layout Description
2767 Action Inserts math objects and symbols.
2768
2769 \end_layout
2770
2771 \begin_layout Description
2772 Syntax math-insert <ARG>
2773 \end_layout
2774
2775 \begin_layout Description
2776 Params <ARG>: Symbol or LaTeX code to be inserted.
2777
2778 \end_layout
2779
2780 \begin_layout Subsection*
2781 LFUN_MATH_SUBSCRIPT
2782 \end_layout
2783
2784 \begin_layout Description
2785 Action Enters subscript expression in math expression.
2786
2787 \end_layout
2788
2789 \begin_layout Description
2790 Syntax math-subscript
2791 \end_layout
2792
2793 \begin_layout Description
2794 Origin vermeer, 12 Dec 2001
2795 \end_layout
2796
2797 \begin_layout Subsection*
2798 LFUN_MATH_SUPERSCRIPT
2799 \end_layout
2800
2801 \begin_layout Description
2802 Action Enters subscript expression in math expression.
2803
2804 \end_layout
2805
2806 \begin_layout Description
2807 Syntax math-superscript
2808 \end_layout
2809
2810 \begin_layout Description
2811 Origin vermeer, 12 Dec 2001
2812 \end_layout
2813
2814 \begin_layout Subsection*
2815 LFUN_MATH_LIMITS
2816 \end_layout
2817
2818 \begin_layout Description
2819 Action Toggles the position of the limits from above/below to the right
2820  side an vice versa in integral symbol, a limit, a summation, etc.
2821
2822 \end_layout
2823
2824 \begin_layout Description
2825 Notion Put the cursor before the symbol with the limits and then invoke
2826  math-limits.
2827
2828 \end_layout
2829
2830 \begin_layout Description
2831 Syntax math-limits [<STATE>]
2832 \end_layout
2833
2834 \begin_layout Description
2835 Params <STATE>: limits|nolimits
2836 \end_layout
2837
2838 \begin_layout Subsection*
2839 LFUN_MATH_MACRO
2840 \end_layout
2841
2842 \begin_layout Description
2843 Action Inserts a math macro definition at the cursor position in the text.
2844
2845 \end_layout
2846
2847 \begin_layout Description
2848 Syntax math-macro <NAME> [<NARGS>] [def]
2849 \end_layout
2850
2851 \begin_layout Description
2852 Params <NAME>: The name of the macro, e.g.
2853  "mymacro".
2854  <NARGS>: The number of parameters of the macro.
2855  Default is 0.
2856  "def": Has no effect anymore, just for compatibility with former LyX versions.
2857
2858 \end_layout
2859
2860 \begin_layout Description
2861 Origin ale, 10 May 1997;  sts, 21 Dec 2007
2862 \end_layout
2863
2864 \begin_layout Subsection*
2865 LFUN_MATH_MUTATE
2866 \end_layout
2867
2868 \begin_layout Description
2869 Action Mutates the type of math inset to the newly selected one.
2870
2871 \end_layout
2872
2873 \begin_layout Description
2874 Syntax math-mutate <TYPE>
2875 \end_layout
2876
2877 \begin_layout Description
2878 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
2879  multline|gather|flalign
2880 \end_layout
2881
2882 \begin_layout Description
2883 Origin Andre, 23 May 2001
2884 \end_layout
2885
2886 \begin_layout Subsection*
2887 LFUN_MATH_SPACE
2888 \end_layout
2889
2890 \begin_layout Description
2891 Action Inserts space into math expression.
2892
2893 \end_layout
2894
2895 \begin_layout Description
2896 Notion Use spacebar after entering this space to change type of space.
2897
2898 \end_layout
2899
2900 \begin_layout Description
2901 Syntax math-space [<TYPE>]
2902 \end_layout
2903
2904 \begin_layout Description
2905 Params <TYPE>: negative spaces: !|negmedspace|negthickspace
2906 \begin_inset Newline newline
2907 \end_inset
2908
2909  positive spaces: ,|:|;|quad|qquad
2910 \begin_inset Newline newline
2911 \end_inset
2912
2913  "," used by default.
2914
2915 \end_layout
2916
2917 \begin_layout Description
2918 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
2919 \end_layout
2920
2921 \begin_layout Subsection*
2922 LFUN_MATH_MATRIX
2923 \end_layout
2924
2925 \begin_layout Description
2926 Action Inserts a matrix.
2927
2928 \end_layout
2929
2930 \begin_layout Description
2931 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
2932 \end_layout
2933
2934 \begin_layout Description
2935 Params <ALIGN>: Alignment is a word composed of the vertical alignment (b,
2936  c or t) (i.e.
2937  1 char) and the horizontal alignments (l, c or r) (i.e.
2938  <COL> chars).
2939
2940 \end_layout
2941
2942 \begin_layout Description
2943 Sample math-matrix 3 3 bccc
2944 \end_layout
2945
2946 \begin_layout Subsection*
2947 LFUN_MATH_MODE
2948 \end_layout
2949
2950 \begin_layout Description
2951 Action In text mode enters math mode (i.e.
2952  puts math insets on the current cursor position), in math mode enters text
2953  mode inside math expression.
2954
2955 \end_layout
2956
2957 \begin_layout Description
2958 Notion If there is some selected text, it puts the text inside created math
2959  box.
2960
2961 \end_layout
2962
2963 \begin_layout Description
2964 Syntax math-mode [<ARG>]
2965 \end_layout
2966
2967 \begin_layout Description
2968 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT
2969  .
2970
2971 \end_layout
2972
2973 \begin_layout Description
2974 Origin Alejandro, 4 Jun 1996
2975 \end_layout
2976
2977 \begin_layout Subsection*
2978 LFUN_MATH_NUMBER_LINE_TOGGLE
2979 \end_layout
2980
2981 \begin_layout Description
2982 Action Toggles numbering of the current formula line.
2983
2984 \end_layout
2985
2986 \begin_layout Description
2987 Notion Must be in display formula mode.
2988
2989 \end_layout
2990
2991 \begin_layout Description
2992 Syntax math-number-line-toggle
2993 \end_layout
2994
2995 \begin_layout Description
2996 Origin Alejandro, 18 Jun 1996
2997 \end_layout
2998
2999 \begin_layout Subsection*
3000 LFUN_MATH_NUMBER_TOGGLE
3001 \end_layout
3002
3003 \begin_layout Description
3004 Action Toggles numbering/labeling of the current formula.
3005
3006 \end_layout
3007
3008 \begin_layout Description
3009 Notion Must be in display formula mode.
3010
3011 \end_layout
3012
3013 \begin_layout Description
3014 Syntax math-number-toggle
3015 \end_layout
3016
3017 \begin_layout Description
3018 Origin Alejandro, 4 Jun 1996
3019 \end_layout
3020
3021 \begin_layout Subsection*
3022 LFUN_MATH_EXTERN
3023 \end_layout
3024
3025 \begin_layout Description
3026 Action Calls external program and passes the current expression/equation
3027  as an argument for the calculation in the format appropriate to the given
3028  language.
3029
3030 \end_layout
3031
3032 \begin_layout Description
3033 Notion Selection can be used to determine the input for the external program.
3034
3035 \end_layout
3036
3037 \begin_layout Description
3038 Syntax math-extern <LANG> [<COMMAND>]
3039 \end_layout
3040
3041 \begin_layout Description
3042 Params <LANG>: octave|maxima|maple|mathematica|script
3043 \begin_inset Newline newline
3044 \end_inset
3045
3046  where "script" stands fot the external script (normalized expression will
3047  be passed)
3048 \end_layout
3049
3050 \begin_layout Description
3051 Origin Andre, 24 Apr 2001
3052 \end_layout
3053
3054 \begin_layout Description
3055 Sample math-extern maple simplify
3056 \end_layout
3057
3058 \begin_layout Subsection*
3059 LFUN_MATH_SIZE
3060 \end_layout
3061
3062 \begin_layout Description
3063 Action Changes arbitrarily the size used by math fonts inside a context.
3064
3065 \end_layout
3066
3067 \begin_layout Description
3068 Notion Provides an interface to the LaTeX math mode font size commands.
3069
3070 \end_layout
3071
3072 \begin_layout Description
3073 Syntax math-size <STYLE>
3074 \end_layout
3075
3076 \begin_layout Description
3077 Params <STYLE>: displaystyle|
3078 \backslash
3079 textstyle|
3080 \backslash
3081 scriptstyle|
3082 \backslash
3083 scriptscriptstyle
3084 \end_layout
3085
3086 \begin_layout Description
3087 Origin Alejandro, 15 Aug 1996; ps, 14 Jun 2008
3088 \end_layout
3089
3090 \begin_layout Subsection*
3091 LFUN_MATH_MACRO_UNFOLD
3092 \end_layout
3093
3094 \begin_layout Description
3095 Action Unfold a Math Macro.
3096
3097 \end_layout
3098
3099 \begin_layout Description
3100 Notion Unfold the Math Macro the cursor is in, i.e.
3101  display it as foo.
3102
3103 \end_layout
3104
3105 \begin_layout Description
3106 Syntax math-macro-unfold
3107 \end_layout
3108
3109 \begin_layout Description
3110 Origin sts, 06 January 2008
3111 \end_layout
3112
3113 \begin_layout Subsection*
3114 LFUN_MATH_MACRO_FOLD
3115 \end_layout
3116
3117 \begin_layout Description
3118 Action Fold a Math Macro.
3119
3120 \end_layout
3121
3122 \begin_layout Description
3123 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e.
3124  displayed as foo before.
3125
3126 \end_layout
3127
3128 \begin_layout Description
3129 Syntax math-macro-fold
3130 \end_layout
3131
3132 \begin_layout Description
3133 Origin sts, 06 January 2008
3134 \end_layout
3135
3136 \begin_layout Subsection*
3137 LFUN_MATH_MACRO_ADD_PARAM
3138 \end_layout
3139
3140 \begin_layout Description
3141 Action Add a parameter.
3142
3143 \end_layout
3144
3145 \begin_layout Description
3146 Notion Add a parameter to a Math Macro.
3147
3148 \end_layout
3149
3150 \begin_layout Description
3151 Params <NUM>: The number of the parameter behind which the new one will
3152  be added (1 for the first, i.e.
3153  use 0 for add a parameter at the left), defaults to the last one.
3154
3155 \end_layout
3156
3157 \begin_layout Description
3158 Syntax math-macro-add-param <NUM>
3159 \end_layout
3160
3161 \begin_layout Description
3162 Origin sts, 06 January 2008
3163 \end_layout
3164
3165 \begin_layout Subsection*
3166 LFUN_MATH_MACRO_REMOVE_PARAM
3167 \end_layout
3168
3169 \begin_layout Description
3170 Action Remove the last parameter.
3171
3172 \end_layout
3173
3174 \begin_layout Description
3175 Notion Remove the last parameter of a Math Macro and remove its value in
3176  all instances of the macro in the buffer.
3177
3178 \end_layout
3179
3180 \begin_layout Description
3181 Params <NUM>: The number of the parameter to be deleted (1 for the first),
3182  defaults to the last one.
3183
3184 \end_layout
3185
3186 \begin_layout Description
3187 Syntax math-macro-remove-param <NUM>
3188 \end_layout
3189
3190 \begin_layout Description
3191 Origin sts, 06 January 2008
3192 \end_layout
3193
3194 \begin_layout Subsection*
3195 LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
3196 \end_layout
3197
3198 \begin_layout Description
3199 Action Append a greedy parameter.
3200
3201 \end_layout
3202
3203 \begin_layout Description
3204 Notion Append a greedy parameter to a Math Macro which eats the following
3205  mathed cell in every instance of the macro in the buffer.
3206
3207 \end_layout
3208
3209 \begin_layout Description
3210 Syntax math-macro-append-greedy-param
3211 \end_layout
3212
3213 \begin_layout Description
3214 Origin sts, 06 January 2008
3215 \end_layout
3216
3217 \begin_layout Subsection*
3218 LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
3219 \end_layout
3220
3221 \begin_layout Description
3222 Action Remove a greedy parameter.
3223
3224 \end_layout
3225
3226 \begin_layout Description
3227 Notion Remove a greedy parameter of a Math Macro and spit out the values
3228  of it in every instance of the macro in the buffer.
3229  If it is an optional parameter the [valud] format is used.
3230
3231 \end_layout
3232
3233 \begin_layout Description
3234 Syntax math-macro-remove-greedy-param
3235 \end_layout
3236
3237 \begin_layout Description
3238 Origin sts, 06 January 2008
3239 \end_layout
3240
3241 \begin_layout Subsection*
3242 LFUN_MATH_MACRO_MAKE_OPTIONAL
3243 \end_layout
3244
3245 \begin_layout Description
3246 Action Make a parameter optional.
3247
3248 \end_layout
3249
3250 \begin_layout Description
3251 Notion Turn the first non-optional parameter of a Math Macro into an optional
3252  parameter with a default value.
3253
3254 \end_layout
3255
3256 \begin_layout Description
3257 Syntax math-macro-make-optional
3258 \end_layout
3259
3260 \begin_layout Description
3261 Origin sts, 06 January 2008
3262 \end_layout
3263
3264 \begin_layout Subsection*
3265 LFUN_MATH_MACRO_MAKE_NONOPTIONAL
3266 \end_layout
3267
3268 \begin_layout Description
3269 Action Make a parameter non-optional.
3270
3271 \end_layout
3272
3273 \begin_layout Description
3274 Notion Turn the last optional parameter of a Math Macro into a non-optional
3275  parameter.
3276  The default value is remembered to be reused later if the user changes
3277  his mind.
3278
3279 \end_layout
3280
3281 \begin_layout Description
3282 Syntax math-macro-make-nonoptional
3283 \end_layout
3284
3285 \begin_layout Description
3286 Origin sts, 06 January 2008
3287 \end_layout
3288
3289 \begin_layout Subsection*
3290 LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
3291 \end_layout
3292
3293 \begin_layout Description
3294 Action Add an optional parameter.
3295
3296 \end_layout
3297
3298 \begin_layout Description
3299 Notion Insert an optional parameter just behind the already existing optional
3300  parameters.
3301
3302 \end_layout
3303
3304 \begin_layout Description
3305 Syntax math-macro-add-optional-param
3306 \end_layout
3307
3308 \begin_layout Description
3309 Origin sts, 06 January 2008
3310 \end_layout
3311
3312 \begin_layout Subsection*
3313 LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
3314 \end_layout
3315
3316 \begin_layout Description
3317 Action Remove the last optional parameter.
3318
3319 \end_layout
3320
3321 \begin_layout Description
3322 Notion Remove the last optional parameter of a Math Macro and remove it
3323  in all the instances of the macro in the buffer.
3324
3325 \end_layout
3326
3327 \begin_layout Description
3328 Syntax math-macro-remove-optional-param
3329 \end_layout
3330
3331 \begin_layout Description
3332 Origin sts, 06 January 2008
3333 \end_layout
3334
3335 \begin_layout Subsection*
3336 LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
3337 \end_layout
3338
3339 \begin_layout Description
3340 Action Add a greedy optional parameter.
3341
3342 \end_layout
3343
3344 \begin_layout Description
3345 Notion Add a greedy optional parameter which eats the value from the following
3346  cells in mathed which are in the [value] format.
3347
3348 \end_layout
3349
3350 \begin_layout Description
3351 Syntax math-macro-add-greedy-optional-param
3352 \end_layout
3353
3354 \begin_layout Description
3355 Origin sts, 06 January 2008
3356 \end_layout
3357
3358 \begin_layout Subsection*
3359 LFUN_IN_MATHMACROTEMPLATE
3360 \end_layout
3361
3362 \begin_layout Description
3363 Action Only active in Math Macro definition.
3364
3365 \end_layout
3366
3367 \begin_layout Description
3368 Notion Dummy function which is only active in a Math Macro definition.
3369  It's used to toggle the Math Macro toolbar if the cursor moves into a Math
3370  Macro definition.
3371
3372 \end_layout
3373
3374 \begin_layout Description
3375 Syntax in-mathmacrotemplate
3376 \end_layout
3377
3378 \begin_layout Description
3379 Origin sts, 06 January 2008
3380 \end_layout
3381
3382 \begin_layout Subsection*
3383 LFUN_PARAGRAPH_MOVE_DOWN
3384 \end_layout
3385
3386 \begin_layout Description
3387 Action Moves the current paragraph downwards in the document.
3388
3389 \end_layout
3390
3391 \begin_layout Description
3392 Syntax paragraph-move-down
3393 \end_layout
3394
3395 \begin_layout Description
3396 Origin Edwin, 8 Apr 2006
3397 \end_layout
3398
3399 \begin_layout Subsection*
3400 LFUN_PARAGRAPH_MOVE_UP
3401 \end_layout
3402
3403 \begin_layout Description
3404 Action Moves the current paragraph upwards in the document.
3405
3406 \end_layout
3407
3408 \begin_layout Description
3409 Syntax paragraph-move-up
3410 \end_layout
3411
3412 \begin_layout Description
3413 Origin Edwin, 8 Apr 2006
3414 \end_layout
3415
3416 \begin_layout Subsection*
3417 LFUN_PARAGRAPH_UP
3418 \end_layout
3419
3420 \begin_layout Description
3421 Action Move the cursor to the next paragraph (or begining of the current
3422  one) in upward direction.
3423
3424 \end_layout
3425
3426 \begin_layout Description
3427 Syntax paragraph-up
3428 \end_layout
3429
3430 \begin_layout Description
3431 Origin Asger, 1 Oct 1996
3432 \end_layout
3433
3434 \begin_layout Subsection*
3435 LFUN_PARAGRAPH_UP_SELECT
3436 \end_layout
3437
3438 \begin_layout Description
3439 Action Move the cursor and select the text to the next paragraph (or begining
3440  of the current one) in upward direction.
3441
3442 \end_layout
3443
3444 \begin_layout Description
3445 Syntax paragraph-up-select
3446 \end_layout
3447
3448 \begin_layout Description
3449 Origin Asger, 1 Oct 1996
3450 \end_layout
3451
3452 \begin_layout Subsection*
3453 LFUN_PARAGRAPH_DOWN
3454 \end_layout
3455
3456 \begin_layout Description
3457 Action Move the cursor to the next paragraph (or begining of the current
3458  one) in downward direction.
3459
3460 \end_layout
3461
3462 \begin_layout Description
3463 Syntax paragraph-down
3464 \end_layout
3465
3466 \begin_layout Description
3467 Origin Asger, 1 Oct 1996
3468 \end_layout
3469
3470 \begin_layout Subsection*
3471 LFUN_PARAGRAPH_DOWN_SELECT
3472 \end_layout
3473
3474 \begin_layout Description
3475 Action Move the cursor and select the text to the next paragraph (or begining
3476  of the current one) in downward direction.
3477
3478 \end_layout
3479
3480 \begin_layout Description
3481 Syntax paragraph-down-select
3482 \end_layout
3483
3484 \begin_layout Description
3485 Origin Asger, 1 Oct 1996
3486 \end_layout
3487
3488 \begin_layout Subsection*
3489 LFUN_PARAGRAPH_GOTO
3490 \end_layout
3491
3492 \begin_layout Description
3493 Action Jump to a paragraph given by its id number and optionally the desired
3494  position within the paragraph.
3495
3496 \end_layout
3497
3498 \begin_layout Description
3499 Notion Note that id number of paragraph is not the sequential number of
3500  paragraph seen on the screen.
3501  Moreover the id is unique for all opened buffers (documents).
3502
3503 \end_layout
3504
3505 \begin_layout Description
3506 Syntax paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
3507 \end_layout
3508
3509 \begin_layout Description
3510 Params <PAR_ID_NUMBER>:  paragraph id
3511 \begin_inset Newline newline
3512 \end_inset
3513
3514  <POSITION_IN_PAR>: desired position within the paragraph
3515 \end_layout
3516
3517 \begin_layout Description
3518 Origin Dekel, 26 Aug 2000
3519 \end_layout
3520
3521 \begin_layout Subsection*
3522 LFUN_BREAK_PARAGRAPH
3523 \end_layout
3524
3525 \begin_layout Description
3526 Action Breaks the current paragraph at the current location.
3527
3528 \end_layout
3529
3530 \begin_layout Description
3531 Syntax break-paragraph
3532 \end_layout
3533
3534 \begin_layout Subsection*
3535 LFUN_BREAK_PARAGRAPH
3536 \end_layout
3537
3538 \begin_layout Description
3539 Action Breaks the current paragraph at the current location.
3540
3541 \end_layout
3542
3543 \begin_layout Description
3544 Notion Removes the selection.
3545
3546 \end_layout
3547
3548 \begin_layout Description
3549 Syntax break-paragraph [<LAYOUT>]
3550 \end_layout
3551
3552 \begin_layout Description
3553 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to
3554  default layout) when the cursor is at the end of the line.
3555
3556 \end_layout
3557
3558 \begin_layout Subsection*
3559 LFUN_PARAGRAPH_PARAMS
3560 \end_layout
3561
3562 \begin_layout Description
3563 Action Change paragraph settings.
3564
3565 \end_layout
3566
3567 \begin_layout Description
3568 Notion Modifies the current paragraph, or currently selected paragraphs.
3569  This function only modifies, and does not override, existing settings.
3570  Note that the "leftindent" indent setting is deprecated.
3571
3572 \end_layout
3573
3574 \begin_layout Description
3575 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
3576 \end_layout
3577
3578 \begin_layout Description
3579 Params <INDENT>:
3580 \backslash
3581 noindent|
3582 \backslash
3583 indent|
3584 \backslash
3585 indent-toggle|
3586 \backslash
3587 leftindent LENGTH
3588 \begin_inset Newline newline
3589 \end_inset
3590
3591  <SPACING>:
3592 \backslash
3593 paragraph_spacing default|single|onehalf|double|other
3594 \begin_inset Newline newline
3595 \end_inset
3596
3597  <ALIGN>:
3598 \backslash
3599 align block|left|right|center|default
3600 \begin_inset Newline newline
3601 \end_inset
3602
3603  <OTHERS>:
3604 \backslash
3605 labelwidthstring WIDTH|
3606 \backslash
3607 start_of_appendix
3608 \begin_inset Newline newline
3609 \end_inset
3610
3611
3612 \end_layout
3613
3614 \begin_layout Description
3615 Origin rgh, Aug 15 2007
3616 \end_layout
3617
3618 \begin_layout Subsection*
3619 LFUN_PARAGRAPH_PARAMS_APPLY
3620 \end_layout
3621
3622 \begin_layout Description
3623 Action Change paragraph settings.
3624
3625 \end_layout
3626
3627 \begin_layout Description
3628 Notion Overwrite all nonspecified settings to the default ones.
3629  Use paragraph-params lfun if you don't want to overwrite others settings.
3630
3631 \end_layout
3632
3633 \begin_layout Description
3634 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
3635 \end_layout
3636
3637 \begin_layout Description
3638 Params For parameters see LFUN_PARAGRAPH_PARAMS
3639 \end_layout
3640
3641 \begin_layout Description
3642 Origin leeming, 30 Mar 2004
3643 \end_layout
3644
3645 \begin_layout Subsection*
3646 LFUN_PARAGRAPH_UPDATE
3647 \end_layout
3648
3649 \begin_layout Description
3650 Action Updates the values inside the paragraph dialog from the paragraph.
3651
3652 \end_layout
3653
3654 \begin_layout Description
3655 Notion This is internal LFUN, not to be used by users.
3656  Called internally by LFUN_DIALOG_UPDATE.
3657
3658 \end_layout
3659
3660 \begin_layout Description
3661 Origin leeming, 13 Mar 2003
3662 \end_layout
3663
3664 \begin_layout Subsection*
3665 LFUN_OUTLINE_UP
3666 \end_layout
3667
3668 \begin_layout Description
3669 Action Move the current group in the upward direction in the structure of
3670  the document.
3671
3672 \end_layout
3673
3674 \begin_layout Description
3675 Notion The "group" can be Part/Chapter/Section/etc.
3676  It moves the whole substructure of the group.
3677
3678 \end_layout
3679
3680 \begin_layout Description
3681 Syntax outline-up
3682 \end_layout
3683
3684 \begin_layout Description
3685 Origin Vermeer, 23 Mar 2006
3686 \end_layout
3687
3688 \begin_layout Subsection*
3689 LFUN_OUTLINE_DOWN
3690 \end_layout
3691
3692 \begin_layout Description
3693 Action Move the current group in the downward direction in the structure
3694  of the document.
3695
3696 \end_layout
3697
3698 \begin_layout Description
3699 Notion The "group" can be Part/Chapter/Section/etc.
3700  It moves the whole substructure of the group.
3701
3702 \end_layout
3703
3704 \begin_layout Description
3705 Syntax outline-down
3706 \end_layout
3707
3708 \begin_layout Description
3709 Origin Vermeer, 23 Mar 2006
3710 \end_layout
3711
3712 \begin_layout Subsection*
3713 LFUN_OUTLINE_IN
3714 \end_layout
3715
3716 \begin_layout Description
3717 Action Moves the current group in the downward direction in the hierarchy
3718  of the document structure.
3719
3720 \end_layout
3721
3722 \begin_layout Description
3723 Notion Part -> Chapter -> Section -> etc.
3724
3725 \end_layout
3726
3727 \begin_layout Description
3728 Syntax outline-in
3729 \end_layout
3730
3731 \begin_layout Description
3732 Origin Vermeer, 23 Mar 2006
3733 \end_layout
3734
3735 \begin_layout Subsection*
3736 LFUN_OUTLINE_OUT
3737 \end_layout
3738
3739 \begin_layout Description
3740 Action Moves the current group in the upward direction in the hierarchy
3741  of the document structure.
3742
3743 \end_layout
3744
3745 \begin_layout Description
3746 Notion Part <- Chapter <- Section <- etc.
3747
3748 \end_layout
3749
3750 \begin_layout Description
3751 Syntax outline-out
3752 \end_layout
3753
3754 \begin_layout Description
3755 Origin Vermeer, 23 Mar 2006
3756 \end_layout
3757
3758 \begin_layout Subsection*
3759 LFUN_INSET_EDIT
3760 \end_layout
3761
3762 \begin_layout Description
3763 Action Edit the inset at cursor with an external application, *
3764      if one is attributed.
3765
3766 \end_layout
3767
3768 \begin_layout Description
3769 Syntax inset-edit [<INSET_PARAMS>]
3770 \end_layout
3771
3772 \begin_layout Description
3773 Params <INSET_PARAMS>: Parameters for the inset.
3774
3775 \begin_inset Newline newline
3776 \end_inset
3777
3778  Currently only the filename will be considered.
3779
3780 \end_layout
3781
3782 \begin_layout Description
3783 Origin JSpitzm, 27 Apr 2006
3784 \end_layout
3785
3786 \begin_layout Subsection*
3787 LFUN_TABULAR_INSERT
3788 \end_layout
3789
3790 \begin_layout Description
3791 Action Inserts table into the document.
3792
3793 \end_layout
3794
3795 \begin_layout Description
3796 Syntax tabular-insert [<ROWS> <COLUMNS>]
3797 \end_layout
3798
3799 \begin_layout Description
3800 Params In case no arguments are given show insert dialog.
3801
3802 \end_layout
3803
3804 \begin_layout Description
3805 Origin Jug, 12 Apr 2000
3806 \end_layout
3807
3808 \begin_layout Subsection*
3809 LFUN_TABULAR_FEATURE
3810 \end_layout
3811
3812 \begin_layout Description
3813 Action Sets various features to the table/cell on the current cursor position.
3814
3815 \end_layout
3816
3817 \begin_layout Description
3818 Notion Various math-environment features are handled here as well, e.g.
3819  add-vline-left/right for Grid/Cases environment
3820 \end_layout
3821
3822 \begin_layout Description
3823 Syntax tabular-feature <FEATURE> [<ARG>]
3824 \end_layout
3825
3826 \begin_layout Description
3827 Params <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|cop
3828 y-column| toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
3829  align-left|align-right|align-center|align-block|valign-top|valign-bottom|
3830  valign-middle|m-align-left|m-align-right|m-align-center|m-valign-top| m-valign-
3831 bottom|m-valign-middle|multicolumn|set-all-lines|unset-all-lines| set-longtabula
3832 r|unset-longtabular|set-pwidth|set-mpwidth| set-rotate-tabular|unset-rotate-tabu
3833 lar|toggle-rotate-tabular| set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|
3834 set-usebox|set-lthead| unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot
3835 |unset-ltfoot| set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
3836  set-special-column|set-special-multi|set-booktabs|unset-booktabs| set-top-space
3837 |set-bottom-space|set-interline-space|set-border-lines
3838 \begin_inset Newline newline
3839 \end_inset
3840
3841  <ARG>: additional argument for some commands, use debug mode to explore
3842  its values.
3843
3844 \end_layout
3845
3846 \begin_layout Description
3847 Origin Jug, 28 Jul 2000
3848 \end_layout
3849
3850 \begin_layout Subsection*
3851 LFUN_CELL_BACKWARD
3852 \end_layout
3853
3854 \begin_layout Description
3855 Action Moves the cursor to the previous cell inside the table.
3856
3857 \end_layout
3858
3859 \begin_layout Description
3860 Syntax cell-backward
3861 \end_layout
3862
3863 \begin_layout Description
3864 Origin Jug, 22 May 2000
3865 \end_layout
3866
3867 \begin_layout Subsection*
3868 LFUN_CELL_FORWARD
3869 \end_layout
3870
3871 \begin_layout Description
3872 Action Moves the cursor to the next cell inside the table.
3873
3874 \end_layout
3875
3876 \begin_layout Description
3877 Syntax cell-forward
3878 \end_layout
3879
3880 \begin_layout Subsection*
3881 LFUN_CELL_SPLIT
3882 \end_layout
3883
3884 \begin_layout Description
3885 Action Splits cell and shifts right part to the next cell (inside the math
3886  grid).
3887
3888 \end_layout
3889
3890 \begin_layout Description
3891 Syntax cell-split
3892 \end_layout
3893
3894 \begin_layout Description
3895 Origin Ale, 15 May 1997
3896 \end_layout
3897
3898 \begin_layout Subsection*
3899 LFUN_VC_REGISTER
3900 \end_layout
3901
3902 \begin_layout Description
3903 Action Register the document as an file inside version control system (RCS,
3904  CVS).
3905
3906 \end_layout
3907
3908 \begin_layout Description
3909 Notion File is registered inside cvs, svn or rcs repository acording to
3910  the existence of cvs/svn/rcs entries in the document's directory.
3911
3912 \begin_inset Newline newline
3913 \end_inset
3914
3915  See LyX Extended Manual (Version Control Chapter) for additional information.
3916
3917 \end_layout
3918
3919 \begin_layout Description
3920 Syntax vc-register
3921 \end_layout
3922
3923 \begin_layout Description
3924 Origin Lgb, 1 Jul 1997
3925 \end_layout
3926
3927 \begin_layout Subsection*
3928 LFUN_VC_CHECK_IN
3929 \end_layout
3930
3931 \begin_layout Description
3932 Action Checks-in/commits the changes of the registered file to the repository.
3933
3934 \end_layout
3935
3936 \begin_layout Description
3937 Notion In RCS case this also unlocks the file.
3938
3939 \end_layout
3940
3941 \begin_layout Description
3942 Syntax vc-check-in
3943 \end_layout
3944
3945 \begin_layout Description
3946 Origin Lgb, 1 Jul 1997
3947 \end_layout
3948
3949 \begin_layout Subsection*
3950 LFUN_VC_CHECK_OUT
3951 \end_layout
3952
3953 \begin_layout Description
3954 Action Checks-out the document for edit (and locks it for RCS).
3955
3956 \end_layout
3957
3958 \begin_layout Description
3959 Notion This is implemented only for RCS and SVN, not CVS.
3960
3961 \end_layout
3962
3963 \begin_layout Description
3964 Syntax vc-check-out
3965 \end_layout
3966
3967 \begin_layout Description
3968 Origin Lgb, 1 Jul 1997
3969 \end_layout
3970
3971 \begin_layout Subsection*
3972 LFUN_VC_REVERT
3973 \end_layout
3974
3975 \begin_layout Description
3976 Action Reverts the document to the last check-in/commit in VCS.
3977
3978 \end_layout
3979
3980 \begin_layout Description
3981 Syntax vc-revert
3982 \end_layout
3983
3984 \begin_layout Description
3985 Origin Lgb, 1 Jul 1997
3986 \end_layout
3987
3988 \begin_layout Subsection*
3989 LFUN_VC_UNDO_LAST
3990 \end_layout
3991
3992 \begin_layout Description
3993 Action Undo last check-in.
3994
3995 \end_layout
3996
3997 \begin_layout Description
3998 Notion This is currently implemented only for RCS.
3999
4000 \end_layout
4001
4002 \begin_layout Description
4003 Syntax vc-check-out
4004 \end_layout
4005
4006 \begin_layout Description
4007 Origin Lgb, 1 Jul 1997
4008 \end_layout
4009
4010 \begin_layout Subsection*
4011 LFUN_CHANGES_TRACK
4012 \end_layout
4013
4014 \begin_layout Description
4015 Action Toggles change tracking to on/off.
4016
4017 \end_layout
4018
4019 \begin_layout Description
4020 Syntax changes-track
4021 \end_layout
4022
4023 \begin_layout Description
4024 Origin levon, 1 Oct 2002
4025 \end_layout
4026
4027 \begin_layout Subsection*
4028 LFUN_CHANGES_OUTPUT
4029 \end_layout
4030
4031 \begin_layout Description
4032 Action Toggles showing of change tracking in typesetted output.
4033
4034 \end_layout
4035
4036 \begin_layout Description
4037 Syntax changes-output
4038 \end_layout
4039
4040 \begin_layout Description
4041 Origin jspitzm, 21 Jan 2005
4042 \end_layout
4043
4044 \begin_layout Subsection*
4045 LFUN_CHANGE_NEXT
4046 \end_layout
4047
4048 \begin_layout Description
4049 Action Moves the cursor to the position of the next change of the change
4050  tracking records.
4051
4052 \end_layout
4053
4054 \begin_layout Description
4055 Syntax change-next
4056 \end_layout
4057
4058 \begin_layout Description
4059 Origin schmitt, 4 Oct 2006
4060 \end_layout
4061
4062 \begin_layout Subsection*
4063 LFUN_CHANGES_MERGE
4064 \end_layout
4065
4066 \begin_layout Description
4067 Action Open change tracking dialog for merging and moves the cursor to the
4068  position of the next change.
4069
4070 \end_layout
4071
4072 \begin_layout Description
4073 Syntax changes-merge
4074 \end_layout
4075
4076 \begin_layout Description
4077 Origin Levon, 16 Oct 2002
4078 \end_layout
4079
4080 \begin_layout Subsection*
4081 LFUN_CHANGE_ACCEPT
4082 \end_layout
4083
4084 \begin_layout Description
4085 Action Accepts tracked change inside the selection.
4086
4087 \end_layout
4088
4089 \begin_layout Description
4090 Syntax change-accept
4091 \end_layout
4092
4093 \begin_layout Description
4094 Origin Levon, 16 Oct 2002
4095 \end_layout
4096
4097 \begin_layout Subsection*
4098 LFUN_CHANGE_REJECT
4099 \end_layout
4100
4101 \begin_layout Description
4102 Action Rejects tracked change inside the selection.
4103
4104 \end_layout
4105
4106 \begin_layout Description
4107 Syntax change-accept
4108 \end_layout
4109
4110 \begin_layout Description
4111 Origin Levon, 16 Oct 2002
4112 \end_layout
4113
4114 \begin_layout Subsection*
4115 LFUN_ALL_CHANGES_ACCEPT
4116 \end_layout
4117
4118 \begin_layout Description
4119 Action Accepts all tracked changes in the document.
4120
4121 \end_layout
4122
4123 \begin_layout Description
4124 Syntax all-changes-accept
4125 \end_layout
4126
4127 \begin_layout Description
4128 Origin Levon, 16 Oct 2002
4129 \end_layout
4130
4131 \begin_layout Subsection*
4132 LFUN_ALL_CHANGES_REJECT
4133 \end_layout
4134
4135 \begin_layout Description
4136 Action Rejects all tracked changes in the document.
4137
4138 \end_layout
4139
4140 \begin_layout Description
4141 Notion Reject does not work recursively; the user may have to repeat the
4142  operation.
4143
4144 \end_layout
4145
4146 \begin_layout Description
4147 Syntax all-changes-reject
4148 \end_layout
4149
4150 \begin_layout Description
4151 Origin Levon, 16 Oct 2002
4152 \end_layout
4153
4154 \begin_layout Subsection*
4155 LFUN_INSET_APPLY
4156 \end_layout
4157
4158 \begin_layout Description
4159 Action Apply data for an inset.
4160
4161 \end_layout
4162
4163 \begin_layout Description
4164 Notion LFUN_INSET_APPLY is sent from the dialogs when the data should be
4165  applied.
4166  This is either changed to LFUN_INSET_MODIFY or LFUN_INSET_INSERT depending
4167  on the context where it is called.
4168
4169 \end_layout
4170
4171 \begin_layout Description
4172 Syntax inset-apply <ARGS>
4173 \end_layout
4174
4175 \begin_layout Description
4176 Params See LFUN_INSET_INSERT .
4177
4178 \end_layout
4179
4180 \begin_layout Subsection*
4181 LFUN_INSET_DISSOLVE
4182 \end_layout
4183
4184 \begin_layout Description
4185 Action Dissolve the current inset into text.
4186
4187 \end_layout
4188
4189 \begin_layout Description
4190 Syntax inset-dissolve [<INSET>]
4191 \end_layout
4192
4193 \begin_layout Description
4194 Params <INSET>: this can be used to make sure the right kind of inset is
4195  dissolved.
4196  For example "dissolve" entry in the charstyles sub-menu should only dissolve
4197  the charstyle inset, even if the cursor is inside several nested insets
4198  of different type.
4199
4200 \begin_inset Newline newline
4201 \end_inset
4202
4203  For values see lyx::InsetLayout::lyxtype_ .
4204
4205 \end_layout
4206
4207 \begin_layout Description
4208 Origin JSpitz, 7 Aug 2006
4209 \end_layout
4210
4211 \begin_layout Subsection*
4212 LFUN_INSET_INSERT
4213 \end_layout
4214
4215 \begin_layout Description
4216 Action Insert new inset (type given by the parameters).
4217
4218 \end_layout
4219
4220 \begin_layout Description
4221 Syntax inset-insert <INSET> <ARGS>
4222 \end_layout
4223
4224 \begin_layout Description
4225 Params <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics| hyperlink|i
4226 nclude|index|label|nomencl|vspace|ref|toc>
4227 \begin_inset Newline newline
4228 \end_inset
4229
4230  <ARGS>: depends on the given inset.
4231  Use "lyx -dbg action" to explore.
4232
4233 \end_layout
4234
4235 \begin_layout Description
4236 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
4237 \backslash
4238 end_inset
4239 \begin_inset Newline newline
4240 \end_inset
4241
4242 where <label name> is the name of the referenced label and<Format> is one
4243  of the following:
4244 \begin_inset Newline newline
4245 \end_inset
4246
4247 ref -- <reference>
4248 \begin_inset Newline newline
4249 \end_inset
4250
4251 eqref -- (<reference>)
4252 \begin_inset Newline newline
4253 \end_inset
4254
4255 pageref -- <page>
4256 \begin_inset Newline newline
4257 \end_inset
4258
4259 vpageref -- on <page>
4260 \begin_inset Newline newline
4261 \end_inset
4262
4263 vref -- <reference> on <page>
4264 \begin_inset Newline newline
4265 \end_inset
4266
4267 prettyref -- Formatted reference
4268 \end_layout
4269
4270 \begin_layout Subsection*
4271 LFUN_INSET_MODIFY
4272 \end_layout
4273
4274 \begin_layout Description
4275 Action Modify existing inset.
4276
4277 \end_layout
4278
4279 \begin_layout Description
4280 Notion Used for label, floats, listings, box, branch, external, wrap bibtex,
4281  ert, command, graphics, note, space, vspace, tabular, bibitem, inlude,
4282  ref insets.
4283
4284 \end_layout
4285
4286 \begin_layout Description
4287 Syntax inset-modify <INSET> <ARGS>
4288 \end_layout
4289
4290 \begin_layout Description
4291 Params See LFUN_INSET_INSERT for further details.
4292
4293 \end_layout
4294
4295 \begin_layout Subsection*
4296 LFUN_NEXT_INSET_MODIFY
4297 \end_layout
4298
4299 \begin_layout Description
4300 Action Modify the inset at cursor position, if there is one.
4301
4302 \end_layout
4303
4304 \begin_layout Description
4305 Notion Used for label, floats, listings, box, branch, external, wrap bibtex,
4306  ert, command, graphics, note, space, vspace, tabular, bibitem, inlude,
4307  ref insets.
4308
4309 \end_layout
4310
4311 \begin_layout Description
4312 Syntax next-inset-modify <INSET> <ARGS>
4313 \end_layout
4314
4315 \begin_layout Description
4316 Syntax next-inset-modify changetype <TYPE>
4317 \end_layout
4318
4319 \begin_layout Description
4320 Params See LFUN_INSET_INSERT for further details.
4321
4322 \end_layout
4323
4324 \begin_layout Description
4325 Origin JSpitzm, 23 Mar 2008
4326 \end_layout
4327
4328 \begin_layout Subsection*
4329 LFUN_INSET_DIALOG_UPDATE
4330 \end_layout
4331
4332 \begin_layout Description
4333 Action Updates the values inside the dialog from the inset.
4334
4335 \end_layout
4336
4337 \begin_layout Description
4338 Notion This is internal LFUN, not to be used by users.
4339  Called internally by LFUN_DIALOG_UPDATE
4340 \end_layout
4341
4342 \begin_layout Description
4343 Params <DIALOG-NAME>
4344 \end_layout
4345
4346 \begin_layout Description
4347 Origin leeming, 25 Feb 2003
4348 \end_layout
4349
4350 \begin_layout Subsection*
4351 LFUN_INSET_SETTINGS
4352 \end_layout
4353
4354 \begin_layout Description
4355 Action Open the inset's properties dialog.
4356
4357 \end_layout
4358
4359 \begin_layout Description
4360 Notion Used for box, branch, ert, float, listings, note, tabular, wrap insets.
4361
4362 \end_layout
4363
4364 \begin_layout Description
4365 Syntax inset-settings <INSET>
4366 \end_layout
4367
4368 \begin_layout Description
4369 Params <INSET>: <box|branch|ert|float|listings|note|tabular|wrap>
4370 \end_layout
4371
4372 \begin_layout Subsection*
4373 LFUN_NEXT_INSET_TOGGLE
4374 \end_layout
4375
4376 \begin_layout Description
4377 Action Toggles the inset at cursor position.
4378  For collapsables, this means it will be (un-)collapsed, in case of other
4379  insets, the editing widget (dialog) will be entered.
4380  Also cf.
4381  LFUN_INSET_SETTINGS.
4382
4383 \end_layout
4384
4385 \begin_layout Description
4386 Notion Used for label, floats, listings, box, branch, external, wrap bibtex,
4387  ert, command, graphics, note, space, vspace, tabular, bibitem, inlude,
4388  ref insets.
4389
4390 \end_layout
4391
4392 \begin_layout Description
4393 Syntax next-inset-toggle <ARG>
4394 \end_layout
4395
4396 \begin_layout Description
4397 Params <ARG>: these are passed as arguments to LFUN_INSET_TOGGLE .
4398
4399 \end_layout
4400
4401 \begin_layout Description
4402 Origin leeming, 30 Mar 2004
4403 \end_layout
4404
4405 \begin_layout Subsection*
4406 LFUN_INSET_TOGGLE
4407 \end_layout
4408
4409 \begin_layout Description
4410 Action Toggles the collapsable inset we are currently in.
4411
4412 \end_layout
4413
4414 \begin_layout Description
4415 Syntax inset-toggle [<ARG>]
4416 \end_layout
4417
4418 \begin_layout Description
4419 Params <ARG>: <open|close|toggle|assign>.
4420
4421 \begin_inset Newline newline
4422 \end_inset
4423
4424  open/close/toggle are for collapsable insets.
4425  close can be currently used by LFUN_NEXT_INSET_TOGGLE.
4426  toggle is used when no argument is given.
4427
4428 \begin_inset Newline newline
4429 \end_inset
4430
4431  assign is for branch inset.
4432
4433 \end_layout
4434
4435 \begin_layout Description
4436 Origin lasgouttes, 19 Jul 2001
4437 \end_layout
4438
4439 \begin_layout Subsection*
4440 LFUN_ALL_INSETS_TOGGLE
4441 \end_layout
4442
4443 \begin_layout Description
4444 Action Toggles (open/closes) all collapsable insets (of a given type) in
4445  the document.
4446
4447 \end_layout
4448
4449 \begin_layout Description
4450 Notion Used for box, branch, ert, float, listings, note, tabular, wrap insets.
4451
4452 \end_layout
4453
4454 \begin_layout Description
4455 Syntax all-insets-toggle <STATE> <INSET>
4456 \end_layout
4457
4458 \begin_layout Description
4459 Params <STATE>: <toggle|open|close> default: toggle
4460 \begin_inset Newline newline
4461 \end_inset
4462
4463  <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all
4464  insets
4465 \end_layout
4466
4467 \begin_layout Description
4468 Origin leeming, 30 Mar 2004
4469 \end_layout
4470
4471 \begin_layout Subsection*
4472 LFUN_SET_GRAPHICS_GROUP
4473 \end_layout
4474
4475 \begin_layout Description
4476 Action Set the group for the graphics inset on the cursor position.
4477
4478 \end_layout
4479
4480 \begin_layout Description
4481 Syntax set-graphics-group [<GROUP>]
4482 \end_layout
4483
4484 \begin_layout Description
4485 Params <GROUP>: Id for an existing group.
4486  In case the Id is an empty string, the graphics inset is removed from the
4487  current group.
4488
4489 \end_layout
4490
4491 \begin_layout Description
4492 Origin sanda, 6 May 2008
4493 \end_layout
4494
4495 \begin_layout Subsection*
4496 LFUN_FINISHED_FORWARD
4497 \end_layout
4498
4499 \begin_layout Description
4500 Action Moves the cursor out of the current slice, going forward.
4501
4502 \end_layout
4503
4504 \begin_layout Description
4505 Notion Cursor movement within an inset may be different than cursor movement
4506  in the surrounding text.
4507  This action should be called automatically by the cursor movement within
4508  the inset, when movement within the inset has ceased (reached the end of
4509  the last paragraph, for example), in order to move correctly back into
4510  the surrounding text.
4511
4512 \end_layout
4513
4514 \begin_layout Subsection*
4515 LFUN_FINISHED_BACKWARD
4516 \end_layout
4517
4518 \begin_layout Description
4519 Action Moves the cursor out of the current slice, going backwards.
4520
4521 \end_layout
4522
4523 \begin_layout Description
4524 Notion See also LFUN_FINISHED_FORWARD.
4525
4526 \end_layout
4527
4528 \begin_layout Subsection*
4529 LFUN_FINISHED_RIGHT
4530 \end_layout
4531
4532 \begin_layout Description
4533 Action Moves the cursor out of the current slice, going right.
4534
4535 \end_layout
4536
4537 \begin_layout Description
4538 Notion See also LFUN_FINISHED_FORWARD
4539 \end_layout
4540
4541 \begin_layout Subsection*
4542 LFUN_FINISHED_LEFT
4543 \end_layout
4544
4545 \begin_layout Description
4546 Action Moves the cursor out of the current slice, going left.
4547
4548 \end_layout
4549
4550 \begin_layout Description
4551 Notion See also LFUN_FINISHED_FORWARD.
4552
4553 \end_layout
4554
4555 \begin_layout Subsection*
4556 LFUN_LANGUAGE
4557 \end_layout
4558
4559 \begin_layout Description
4560 Action Set language from the current cursor position.
4561
4562 \end_layout
4563
4564 \begin_layout Description
4565 Syntax language <LANG>
4566 \end_layout
4567
4568 \begin_layout Description
4569 Params <LANG>: Requested language.
4570  Look in lib/languages for the list.
4571
4572 \end_layout
4573
4574 \begin_layout Description
4575 Origin Dekel, 2 Mar 2000
4576 \end_layout
4577
4578 \begin_layout Subsection*
4579 LFUN_LABEL_GOTO
4580 \end_layout
4581
4582 \begin_layout Description
4583 Action Goto a label.
4584
4585 \end_layout
4586
4587 \begin_layout Description
4588 Syntax label-goto [<LABEL>]
4589 \end_layout
4590
4591 \begin_layout Description
4592 Params <LABEL>: Requested label.
4593  If no label is given and refernce is on cursor position, Bookmark 0 is
4594  saved and cursor moves to the position of referenced label.
4595
4596 \end_layout
4597
4598 \begin_layout Description
4599 Origin Ale, 6 Aug 1997
4600 \end_layout
4601
4602 \begin_layout Subsection*
4603 LFUN_LABEL_INSERT
4604 \end_layout
4605
4606 \begin_layout Description
4607 Action Inserts label to text or displayed formula.
4608
4609 \end_layout
4610
4611 \begin_layout Description
4612 Syntax label-insert [<LABEL>]
4613 \end_layout
4614
4615 \begin_layout Description
4616 Params <LABEL>: Requested label.
4617  If no label is given dialog requesting name will be opened.
4618
4619 \end_layout
4620
4621 \begin_layout Subsection*
4622 LFUN_REFERENCE_NEXT
4623 \end_layout
4624
4625 \begin_layout Description
4626 Action Go to the next label or cross-reference.
4627
4628 \end_layout
4629
4630 \begin_layout Description
4631 Syntax reference-next
4632 \end_layout
4633
4634 \begin_layout Description
4635 Origin Dekel, 14 Jan 2001
4636 \end_layout
4637
4638 \begin_layout Subsection*
4639 LFUN_BOOKMARK_GOTO
4640 \end_layout
4641
4642 \begin_layout Description
4643 Action Goto a bookmark.
4644
4645 \end_layout
4646
4647 \begin_layout Description
4648 Notion Moves the cursor to the numbered bookmark, opening the file if necessary.
4649  Note that bookmarsk are saved per-session, not per file.
4650
4651 \end_layout
4652
4653 \begin_layout Description
4654 Syntax bookmark-goto <NUMBER>
4655 \end_layout
4656
4657 \begin_layout Description
4658 Params <NUMBER>: the number of the bookmark to restore.
4659
4660 \end_layout
4661
4662 \begin_layout Description
4663 Origin Dekel, 27 January 2001
4664 \end_layout
4665
4666 \begin_layout Subsection*
4667 LFUN_BOOKMARK_SAVE
4668 \end_layout
4669
4670 \begin_layout Description
4671 Action Save a bookmark.
4672
4673 \end_layout
4674
4675 \begin_layout Description
4676 Notion Saves a numbered bookmark to the sessions file.
4677  The number must be between 1 and 9, inclusive.
4678  Note that bookmarks are saved per-session, not per file.
4679
4680 \end_layout
4681
4682 \begin_layout Description
4683 Syntax bookmark-save <NUMBER>
4684 \end_layout
4685
4686 \begin_layout Description
4687 Params <NUMBER>: the number of the bookmark to save.
4688
4689 \end_layout
4690
4691 \begin_layout Description
4692 Origin Dekel, 27 January 2001
4693 \end_layout
4694
4695 \begin_layout Subsection*
4696 LFUN_BOOKMARK_CLEAR
4697 \end_layout
4698
4699 \begin_layout Description
4700 Action Clears the list of saved bookmarks.
4701
4702 \end_layout
4703
4704 \begin_layout Description
4705 Syntax bookmark-clear
4706 \end_layout
4707
4708 \begin_layout Description
4709 Origin bpeng, 31 October 2006
4710 \end_layout
4711
4712 \begin_layout Subsection*
4713 LFUN_HELP_OPEN
4714 \end_layout
4715
4716 \begin_layout Description
4717 Action Open the given help file according to the language setting.
4718
4719 \end_layout
4720
4721 \begin_layout Description
4722 Syntax help-open <FILE>[.lyx]
4723 \end_layout
4724
4725 \begin_layout Description
4726 Params <FILE>: any document from (/usr/share/)doc directory.
4727
4728 \end_layout
4729
4730 \begin_layout Description
4731 Origin Jug, 27 Jun 1999
4732 \end_layout
4733
4734 \begin_layout Subsection*
4735 LFUN_LYX_QUIT
4736 \end_layout
4737
4738 \begin_layout Description
4739 Action Terminates the current LyX instance.
4740
4741 \end_layout
4742
4743 \begin_layout Description
4744 Notion Terminates the current LyX instance, asking whether to save modified
4745  documents, etc.
4746
4747 \end_layout
4748
4749 \begin_layout Description
4750 Syntax lyx-quit
4751 \end_layout
4752
4753 \begin_layout Subsection*
4754 LFUN_TOOLBAR_TOGGLE
4755 \end_layout
4756
4757 \begin_layout Description
4758 Action Toggles visibility of a given toolbar between on/off/auto.
4759
4760 \end_layout
4761
4762 \begin_layout Description
4763 Notion Skiping "auto" when allowauto is false.
4764
4765 \end_layout
4766
4767 \begin_layout Description
4768 Syntax toolbar-toggle <NAME> [allowauto]
4769 \end_layout
4770
4771 \begin_layout Description
4772 Params <NAME>: standard|extra|table|math|mathmacrotemplate| minibuffer|review|vi
4773 ew/update|math_panels|vcs
4774 \end_layout
4775
4776 \begin_layout Description
4777 Origin Edwin, 21 May 2007
4778 \end_layout
4779
4780 \begin_layout Subsection*
4781 LFUN_MENU_OPEN
4782 \end_layout
4783
4784 \begin_layout Description
4785 Action Opens the menu given by its name.
4786
4787 \end_layout
4788
4789 \begin_layout Description
4790 Syntax menu-open <NAME>
4791 \end_layout
4792
4793 \begin_layout Description
4794 Params <NAME>: menu name.
4795  See various .inc files in lib/ui for candidates.
4796
4797 \end_layout
4798
4799 \begin_layout Subsection*
4800 LFUN_UI_TOGGLE
4801 \end_layout
4802
4803 \begin_layout Description
4804 Action Various UI visibility-toggling actions.
4805
4806 \end_layout
4807
4808 \begin_layout Description
4809 Syntax ui-toggle <statusbar|menubar|frame|fullscreen>
4810 \end_layout
4811
4812 \begin_layout Description
4813 Params statusbar  : Toggle visibility of the statusbar.
4814
4815 \begin_inset Newline newline
4816 \end_inset
4817
4818  menubar    : Toggle visibility of the menubar.
4819
4820 \begin_inset Newline newline
4821 \end_inset
4822
4823  scrollbar  : Toggle visibility of the scrollbar.
4824
4825 \begin_inset Newline newline
4826 \end_inset
4827
4828  frame      : Toggle visibility of the frames around editing window.
4829
4830 \begin_inset Newline newline
4831 \end_inset
4832
4833  fullscreen : Toggle fullscreen mode.
4834  This also covers calling the previous functions.
4835  However LFUN_TOOLBAR_TOGGLE for the custom tweaks of the toolbars should
4836  be used.
4837
4838 \end_layout
4839
4840 \begin_layout Description
4841 Origin sanda, 9 Feb 2007
4842 \end_layout
4843
4844 \begin_layout Subsection*
4845 WINDOW_NEW
4846 \end_layout
4847
4848 \begin_layout Description
4849 Action Creates new empty LyX window.
4850
4851 \end_layout
4852
4853 \begin_layout Description
4854 Notion Already opened documents from the previous window can be found under
4855  View menu.
4856
4857 \end_layout
4858
4859 \begin_layout Description
4860 Syntax window-new [<GEOMETRY>]
4861 \end_layout
4862
4863 \begin_layout Description
4864 Params <GEOMETRY>: pass the geometry of the window.
4865  This parameter is currently accepted only on Windows platform.
4866
4867 \end_layout
4868
4869 \begin_layout Description
4870 Origin Abdel, 21 Oct 2006
4871 \end_layout
4872
4873 \begin_layout Subsection*
4874 LFUN_WINDOW_CLOSE
4875 \end_layout
4876
4877 \begin_layout Description
4878 Action Closes the current LyX window.
4879
4880 \end_layout
4881
4882 \begin_layout Description
4883 Syntax window-close
4884 \end_layout
4885
4886 \begin_layout Description
4887 Origin Abdel, 23 Oct 2006
4888 \end_layout
4889
4890 \begin_layout Subsection*
4891 LFUN_SPLIT_VIEW
4892 \end_layout
4893
4894 \begin_layout Description
4895 Action Creates another split view of current buffer.
4896
4897 \end_layout
4898
4899 \begin_layout Description
4900 Notion All split views act in the same way indpendently.
4901
4902 \end_layout
4903
4904 \begin_layout Description
4905 Syntax split-view <vertical|horizontal>
4906 \end_layout
4907
4908 \begin_layout Description
4909 Params horizontal : The work areas are laid out side by side.
4910
4911 \begin_inset Newline newline
4912 \end_inset
4913
4914  vertical   : The work areas laid out vertically.
4915
4916 \end_layout
4917
4918 \begin_layout Description
4919 Origin Abdel, 20 Feb 2008
4920 \end_layout
4921
4922 \begin_layout Subsection*
4923 LFUN_CLOSE_TAB_GROUP
4924 \end_layout
4925
4926 \begin_layout Description
4927 Action Close the current tab group.
4928
4929 \end_layout
4930
4931 \begin_layout Description
4932 Notion This only closes the work areas, not the buffer themselves.
4933  The still opened buffers can be visualized in another tab group.
4934
4935 \end_layout
4936
4937 \begin_layout Description
4938 Syntax close-tab-group
4939 \end_layout
4940
4941 \begin_layout Description
4942 Origin Abdel, 21 Feb 2008
4943 \end_layout
4944
4945 \begin_layout Subsection*
4946 LFUN_DIALOG_SHOW
4947 \end_layout
4948
4949 \begin_layout Description
4950 Action Shows hidden dialog or create new one for a given function/inset
4951  settings etc.
4952
4953 \end_layout
4954
4955 \begin_layout Description
4956 Syntax dialog-show <NAME> [<DATA>]
4957 \end_layout
4958
4959 \begin_layout Description
4960 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
4961
4962 \begin_inset Newline newline
4963 \end_inset
4964
4965  document|errorlist|ert|external|file|findreplace|float|graphics|
4966 \begin_inset Newline newline
4967 \end_inset
4968
4969  include|index|info|nomenclature|label|log|mathdelimiter|mathmatrix|
4970 \begin_inset Newline newline
4971 \end_inset
4972
4973  note|paragraph|prefs|print|ref|sendto|space|spellchecker|symbols|
4974 \begin_inset Newline newline
4975 \end_inset
4976
4977  tabular|tabularcreate|thesaurus|texinfo|toc|href|view-source|vspace
4978 \begin_inset Newline newline
4979 \end_inset
4980
4981  wrap|listings|<SPECIAL>
4982 \begin_inset Newline newline
4983 \end_inset
4984
4985  <SPECIAL>: latexlog|vclog
4986 \begin_inset Newline newline
4987 \end_inset
4988
4989  <DATA>: data, usually settings for the given dialog.
4990  Use debug mode for the details.
4991
4992 \end_layout
4993
4994 \begin_layout Description
4995 Origin leeming, 17 Jun 2003
4996 \end_layout
4997
4998 \begin_layout Subsection*
4999 LFUN_DIALOG_SHOW_NEW_INSET
5000 \end_layout
5001
5002 \begin_layout Description
5003 Action Shows hidden dialog or create new one for a given inset settings
5004  etc.
5005
5006 \end_layout
5007
5008 \begin_layout Description
5009 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given
5010  inset.
5011
5012 \end_layout
5013
5014 \begin_layout Description
5015 Syntax dialog-show-new-inset <NAME> [<DATA>]
5016 \end_layout
5017
5018 \begin_layout Description
5019 Params See LFUN_DIALOG_SHOW .
5020
5021 \end_layout
5022
5023 \begin_layout Description
5024 Origin leeming, 25 Feb 2003
5025 \end_layout
5026
5027 \begin_layout Subsection*
5028 LFUN_DIALOG_UPDATE
5029 \end_layout
5030
5031 \begin_layout Description
5032 Action Updates the dialog values from the inset/paragraph/document.
5033
5034 \end_layout
5035
5036 \begin_layout Description
5037 Syntax dialog-update <NAME>
5038 \end_layout
5039
5040 \begin_layout Description
5041 Params <NAME>: paragraph|prefs|<INSET>
5042 \begin_inset Newline newline
5043 \end_inset
5044
5045  <INSET>: inset name
5046 \end_layout
5047
5048 \begin_layout Description
5049 Origin leeming, 25 Feb 2003
5050 \end_layout
5051
5052 \begin_layout Subsection*
5053 LFUN_DIALOG_HIDE
5054 \end_layout
5055
5056 \begin_layout Description
5057 Action Hides showed dialog.
5058  Counterpart to LFUN_DIALOG_SHOW .
5059
5060 \end_layout
5061
5062 \begin_layout Description
5063 Syntax dialog-hide <NAME>
5064 \end_layout
5065
5066 \begin_layout Description
5067 Params See LFUN_DIALOG_SHOW .
5068
5069 \end_layout
5070
5071 \begin_layout Description
5072 Origin leeming, 25 Feb 2003
5073 \end_layout
5074
5075 \begin_layout Subsection*
5076 LFUN_DIALOG_TOGGLE
5077 \end_layout
5078
5079 \begin_layout Description
5080 Action Toggles dialog between showed/hidden state.
5081
5082 \end_layout
5083
5084 \begin_layout Description
5085 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
5086
5087 \end_layout
5088
5089 \begin_layout Description
5090 Syntax dialog-toggle <NAME> [<DATA>]
5091 \end_layout
5092
5093 \begin_layout Description
5094 Params See LFUN_DIALOG_SHOW .
5095
5096 \end_layout
5097
5098 \begin_layout Description
5099 Origin JSpitzm, 30 Apr 2007
5100 \end_layout
5101
5102 \begin_layout Subsection*
5103 LFUN_DIALOG_DISCONNECT_INSET
5104 \end_layout
5105
5106 \begin_layout Description
5107 Action Closes opened connection to opened inset.
5108
5109 \end_layout
5110
5111 \begin_layout Description
5112 Notion Connection is used for apply functions.
5113
5114 \end_layout
5115
5116 \begin_layout Description
5117 Syntax dialog-disconnect-inset <INSET-NAME>
5118 \end_layout
5119
5120 \begin_layout Description
5121 Origin leeming, 25 Feb 2003
5122 \end_layout
5123
5124 \begin_layout Subsection*
5125 LFUN_MOUSE_PRESS
5126 \end_layout
5127
5128 \begin_layout Description
5129 Action This function is called when mouse button is pressed (inside workarea).Act
5130 ion depends on the context.
5131
5132 \end_layout
5133
5134 \begin_layout Description
5135 Notion This is internal LFUN, not to be used by users.
5136
5137 \end_layout
5138
5139 \begin_layout Description
5140 Origin Andre, 9 Aug 2002
5141 \end_layout
5142
5143 \begin_layout Subsection*
5144 LFUN_MOUSE_DOUBLE
5145 \end_layout
5146
5147 \begin_layout Description
5148 Action This function is called when double click on mouse button is pressed
5149  (inside workarea).
5150  Action depends on the context.
5151
5152 \end_layout
5153
5154 \begin_layout Description
5155 Notion This is internal LFUN, not to be used by users.
5156
5157 \end_layout
5158
5159 \begin_layout Description
5160 Origin Andre, 9 Aug 2002
5161 \end_layout
5162
5163 \begin_layout Subsection*
5164 LFUN_MOUSE_TRIPLE
5165 \end_layout
5166
5167 \begin_layout Description
5168 Action This function is called when triple click on mouse button is pressed
5169  (inside workarea).
5170  Action depends on the context.
5171
5172 \end_layout
5173
5174 \begin_layout Description
5175 Notion This is internal LFUN, not to be used by users.
5176
5177 \end_layout
5178
5179 \begin_layout Description
5180 Origin Andre, 9 Aug 2002
5181 \end_layout
5182
5183 \begin_layout Subsection*
5184 LFUN_MOUSE_MOTION
5185 \end_layout
5186
5187 \begin_layout Description
5188 Action This function is called when mouse cursor is moving over the text.Action
5189  depends on the context.
5190
5191 \end_layout
5192
5193 \begin_layout Description
5194 Notion This is internal LFUN, not to be used by users.
5195
5196 \end_layout
5197
5198 \begin_layout Description
5199 Origin Andre, 9 Aug 2002
5200 \end_layout
5201
5202 \begin_layout Subsection*
5203 LFUN_MOUSE_RELEASE
5204 \end_layout
5205
5206 \begin_layout Description
5207 Action This function is called when mouse button is released (inside workarea).Ac
5208 tion depends on the context.
5209
5210 \end_layout
5211
5212 \begin_layout Description
5213 Notion This is internal LFUN, not to be used by users.
5214
5215 \end_layout
5216
5217 \begin_layout Description
5218 Origin Andre, 9 Aug 2002
5219 \end_layout
5220
5221 \begin_layout Subsection*
5222 LFUN_KEYMAP_OFF
5223 \end_layout
5224
5225 \begin_layout Description
5226 Action Turn off the loaded keyboard map.
5227
5228 \end_layout
5229
5230 \begin_layout Description
5231 Syntax keymap-off
5232 \end_layout
5233
5234 \begin_layout Subsection*
5235 LFUN_KEYMAP_PRIMARY
5236 \end_layout
5237
5238 \begin_layout Description
5239 Action Turn on the primary keyboard map.
5240
5241 \end_layout
5242
5243 \begin_layout Description
5244 Notion Maps were widely used in past, when X-windows didn't have nowadays
5245  keyboard support.
5246  They can be still used to maintain uniform keyboard layout across the various
5247  plaforms.
5248
5249 \begin_inset Newline newline
5250 \end_inset
5251
5252  The language is to be set in the Preferences dialog.
5253
5254 \end_layout
5255
5256 \begin_layout Description
5257 Syntax keymap-primary
5258 \end_layout
5259
5260 \begin_layout Subsection*
5261 LFUN_KEYMAP_SECONDARY
5262 \end_layout
5263
5264 \begin_layout Description
5265 Action Turn on the secondary keyboard map.
5266
5267 \end_layout
5268
5269 \begin_layout Description
5270 Syntax keymap-secondary
5271 \end_layout
5272
5273 \begin_layout Subsection*
5274 LFUN_KEYMAP_TOGGLE
5275 \end_layout
5276
5277 \begin_layout Description
5278 Action Toggles keyboard maps (first/second/off).
5279
5280 \end_layout
5281
5282 \begin_layout Description
5283 Syntax keymap-toggle
5284 \end_layout
5285
5286 \begin_layout Description
5287 Origin leeming, 30 Mar 2004
5288 \end_layout
5289
5290 \begin_layout Subsection*
5291 LFUN_SERVER_GET_LAYOUT
5292 \end_layout
5293
5294 \begin_layout Description
5295 Action Returns the current layout (that is environment) name on the cursor
5296  position.
5297
5298 \end_layout
5299
5300 \begin_layout Description
5301 Syntax server-get-layout
5302 \end_layout
5303
5304 \begin_layout Subsection*
5305 LFUN_SERVER_GET_FILENAME
5306 \end_layout
5307
5308 \begin_layout Description
5309 Action Returns path and file name of the currently edited document.
5310
5311 \end_layout
5312
5313 \begin_layout Description
5314 Syntax server-get-filename
5315 \end_layout
5316
5317 \begin_layout Subsection*
5318 LFUN_SERVER_GOTO_FILE_ROW
5319 \end_layout
5320
5321 \begin_layout Description
5322 Action Sets the cursor position based on the row number of generated TeX
5323  file.
5324
5325 \end_layout
5326
5327 \begin_layout Description
5328 Syntax server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
5329 \end_layout
5330
5331 \begin_layout Description
5332 Origin Edmar, 23 Dec 1998
5333 \end_layout
5334
5335 \begin_layout Subsection*
5336 LFUN_SERVER_NOTIFY
5337 \end_layout
5338
5339 \begin_layout Description
5340 Action Sends notify message about the last key-sequence to client.
5341
5342 \end_layout
5343
5344 \begin_layout Description
5345 Notion This can be used to grab last key-sequence used inside the LyX window.
5346  See also Debug extensions section in Extended features manual.
5347
5348 \end_layout
5349
5350 \begin_layout Description
5351 Syntax server-notify
5352 \end_layout
5353
5354 \begin_layout Subsection*
5355 LFUN_SERVER_SET_XY
5356 \end_layout
5357
5358 \begin_layout Description
5359 Action Sets the cursor position based on the editing area coordinates (similar
5360  as clicking on that point with left mouse button).
5361
5362 \end_layout
5363
5364 \begin_layout Description
5365 Syntax server-set-xy <X> <Y>
5366 \end_layout
5367
5368 \begin_layout Subsection*
5369 LFUN_SERVER_GET_XY
5370 \end_layout
5371
5372 \begin_layout Description
5373 Action Returns the coordinates of cursor position in the editing area.
5374
5375 \end_layout
5376
5377 \begin_layout Description
5378 Syntax server-get-xy
5379 \end_layout
5380
5381 \begin_layout Subsection*
5382 LFUN_BUILD_PROGRAM
5383 \end_layout
5384
5385 \begin_layout Description
5386 Action Generates the code (literate programming).
5387
5388 \end_layout
5389
5390 \begin_layout Description
5391 Notion Latex file with extension literate_extension is generated.
5392  Then LyX invokes build_command (with a default of``make'') to generate
5393  the code and build_error_filter to process the compilation error messages.
5394
5395 \begin_inset Newline newline
5396 \end_inset
5397
5398  In case you want to process your literate file with a script, or some other
5399  program, just insert in your lyxrc file an entry with:
5400 \begin_inset Newline newline
5401 \end_inset
5402
5403  build_command "my_script my_arguments"
5404 \begin_inset Newline newline
5405 \end_inset
5406
5407  The build_error_filter differs from the literate_error_filter only in that
5408  the former will identify error messages from your compiler.
5409
5410 \end_layout
5411
5412 \begin_layout Description
5413 Syntax build-program
5414 \end_layout
5415
5416 \begin_layout Subsection*
5417 LFUN_BUFFER_AUTO_SAVE
5418 \end_layout
5419
5420 \begin_layout Description
5421 Action Saves the current buffer to a temporary file.
5422
5423 \end_layout
5424
5425 \begin_layout Description
5426 Notion Saves the current buffer to a file named "#filename#".
5427  This LFUN is called automatically by LyX, to "autosave" the current buffer.
5428
5429 \end_layout
5430
5431 \begin_layout Description
5432 Syntax buffer-auto-save
5433 \end_layout
5434
5435 \begin_layout Subsection*
5436 LFUN_BUFFER_CHILD_OPEN
5437 \end_layout
5438
5439 \begin_layout Description
5440 Action Loads the given child document.
5441
5442 \end_layout
5443
5444 \begin_layout Description
5445 Notion The current document is treated as a parent.
5446
5447 \end_layout
5448
5449 \begin_layout Description
5450 Syntax buffer-child-open <FILE>
5451 \end_layout
5452
5453 \begin_layout Description
5454 Params <FILE>: Filename of the child.
5455  The directory of the parent is assumed by default.
5456
5457 \end_layout
5458
5459 \begin_layout Description
5460 Origin Ale, 28 May 1997
5461 \end_layout
5462
5463 \begin_layout Subsection*
5464 LFUN_BUFFER_CHKTEX
5465 \end_layout
5466
5467 \begin_layout Description
5468 Action Runs chktex for the current document.
5469
5470 \end_layout
5471
5472 \begin_layout Description
5473 Syntax buffer-chktex
5474 \end_layout
5475
5476 \begin_layout Description
5477 Origin Asger, 30 Oct 1997
5478 \end_layout
5479
5480 \begin_layout Subsection*
5481 LFUN_BUFFER_TOGGLE_COMPRESSION
5482 \end_layout
5483
5484 \begin_layout Description
5485 Action Toggles compression of the current document on/off.
5486
5487 \end_layout
5488
5489 \begin_layout Description
5490 Syntax buffer-toggle-compression
5491 \end_layout
5492
5493 \begin_layout Description
5494 Origin bpeng, 27 Apr 2006
5495 \end_layout
5496
5497 \begin_layout Subsection*
5498 LFUN_BUFFER_CLOSE
5499 \end_layout
5500
5501 \begin_layout Description
5502 Action Closes the current buffer.
5503
5504 \end_layout
5505
5506 \begin_layout Description
5507 Notion Closes the current buffer, asking whether to save it, etc, if the
5508  buffer has been modified.
5509
5510 \end_layout
5511
5512 \begin_layout Description
5513 Syntax buffer-close
5514 \end_layout
5515
5516 \begin_layout Subsection*
5517 LFUN_BUFFER_EXPORT
5518 \end_layout
5519
5520 \begin_layout Description
5521 Action Exports the current buffer (document) to the given format.
5522
5523 \end_layout
5524
5525 \begin_layout Description
5526 Syntax buffer-export <FORMAT>
5527 \end_layout
5528
5529 \begin_layout Description
5530 Params <FORMAT> is either "custom" or one of the formats which you can find
5531  in Tools->Preferences->File formats->Format.
5532  Usual format you will enter is "pdf2" (pdflatex), "pdflatex" (plain tex
5533  for pdflatex) or "ps" for postscript.
5534
5535 \begin_inset Newline newline
5536 \end_inset
5537
5538  In case of "custom" you will be asked for a format you want to start from
5539  and for the command that you want to apply to this format.
5540  Internally the control is then passed to LFUN_BUFFER_EXPORT_CUSTOM.
5541
5542 \end_layout
5543
5544 \begin_layout Description
5545 Origin Lgb, 29 Jul 1997
5546 \end_layout
5547
5548 \begin_layout Subsection*
5549 LFUN_BUFFER_EXPORT_CUSTOM
5550 \end_layout
5551
5552 \begin_layout Description
5553 Action Exports the current buffer (document) from the given format using
5554  the given command on it.
5555
5556 \end_layout
5557
5558 \begin_layout Description
5559 Syntax buffer-export-custom <FORMAT> <COMMAND>
5560 \end_layout
5561
5562 \begin_layout Description
5563 Params <FORMAT> format to start from (LyX will care to produce such intermediate
5564  file).
5565
5566 \begin_inset Newline newline
5567 \end_inset
5568
5569  <COMMAND> this command will be launched on the file.
5570  Note that you can use "$$FName" string to qualify the intermediate file.
5571
5572 \end_layout
5573
5574 \begin_layout Description
5575 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
5576 \end_layout
5577
5578 \begin_layout Description
5579 Origin leeming, 27 Mar 2004
5580 \end_layout
5581
5582 \begin_layout Subsection*
5583 LFUN_BUFFER_PRINT
5584 \end_layout
5585
5586 \begin_layout Description
5587 Action Prints the current document.
5588
5589 \end_layout
5590
5591 \begin_layout Description
5592 Notion Many settings can be given via the preferences dialog.
5593
5594 \end_layout
5595
5596 \begin_layout Description
5597 Syntax buffer-print <TARGET> <TARGET-NAME> <COMMAND>
5598 \end_layout
5599
5600 \begin_layout Description
5601 Params <TARGET> is either "printer" or "file".
5602
5603 \begin_inset Newline newline
5604 \end_inset
5605
5606  <TARGER-NAME> is either "default" or file name or printer name.
5607
5608 \begin_inset Newline newline
5609 \end_inset
5610
5611  <COMMAND> command ensuring the printing job.
5612
5613 \end_layout
5614
5615 \begin_layout Description
5616 Sample buffer-print file "/trash/newfile1.ps" "dvips"
5617 \end_layout
5618
5619 \begin_layout Description
5620 Origin leeming, 28 Mar 2004
5621 \end_layout
5622
5623 \begin_layout Subsection*
5624 LFUN_BUFFER_IMPORT
5625 \end_layout
5626
5627 \begin_layout Description
5628 Action Import a given file as a lyx document.
5629
5630 \end_layout
5631
5632 \begin_layout Description
5633 Notion File can be imported iff lyx file format is (transitively) reachable
5634  via defined convertors in preferences.
5635  Look into File->Import menu to get an idea of the currently active import
5636  formats.
5637
5638 \end_layout
5639
5640 \begin_layout Description
5641 Syntax buffer-import <FORMAT> [<FILE>]
5642 \end_layout
5643
5644 \begin_layout Description
5645 Origin Asger, 24 Jul 1998
5646 \end_layout
5647
5648 \begin_layout Subsection*
5649 LFUN_BUFFER_NEW
5650 \end_layout
5651
5652 \begin_layout Description
5653 Action Creates a new buffer (that is, document).
5654
5655 \end_layout
5656
5657 \begin_layout Description
5658 Notion Implicit path can be set in Preferences dialog.
5659
5660 \end_layout
5661
5662 \begin_layout Description
5663 Syntax buffer-new [<FILE>]
5664 \end_layout
5665
5666 \begin_layout Description
5667 Params <FILE>: filename of created file with absolute path.
5668
5669 \end_layout
5670
5671 \begin_layout Subsection*
5672 LFUN_BUFFER_NEW_TEMPLATE
5673 \end_layout
5674
5675 \begin_layout Description
5676 Action Creates a new buffer (that is, document) from a template.
5677
5678 \end_layout
5679
5680 \begin_layout Description
5681 Notion Path for new files and templates can be set in Preferences dialog.
5682  Template will be asked for via Open-dialog.
5683
5684 \end_layout
5685
5686 \begin_layout Description
5687 Syntax buffer-new-template [<FILE>]
5688 \end_layout
5689
5690 \begin_layout Description
5691 Params <FILE>: filename of created file with absolute path.
5692
5693 \end_layout
5694
5695 \begin_layout Subsection*
5696 LFUN_BUFFER_RELOAD
5697 \end_layout
5698
5699 \begin_layout Description
5700 Action Reverts opened document.
5701
5702 \end_layout
5703
5704 \begin_layout Description
5705 Syntax buffer-reload
5706 \end_layout
5707
5708 \begin_layout Description
5709 Origin Asger, 2 Feb 1997
5710 \end_layout
5711
5712 \begin_layout Subsection*
5713 LFUN_BUFFER_SWITCH
5714 \end_layout
5715
5716 \begin_layout Description
5717 Action Switch to the given buffer.
5718
5719 \end_layout
5720
5721 \begin_layout Description
5722 Notion This is useful also in case you need simultaneously more views of
5723  the edited document in different LyX windows.
5724
5725 \end_layout
5726
5727 \begin_layout Description
5728 Syntax buffer-new-template <BUFFER>
5729 \end_layout
5730
5731 \begin_layout Description
5732 Params <BUFFER>: already opened document which is to be shown.
5733
5734 \end_layout
5735
5736 \begin_layout Subsection*
5737 LFUN_BUFFER_TOGGLE_READ_ONLY
5738 \end_layout
5739
5740 \begin_layout Description
5741 Action Toggle editing mode of the current document between read/write and
5742  read-only.
5743
5744 \end_layout
5745
5746 \begin_layout Description
5747 Notion In the ->Readonly mode checks-in/commits the data if the file is
5748  under version control.
5749  In the Readonly-> mode checkouts the data from repository.
5750
5751 \begin_inset Newline newline
5752 \end_inset
5753
5754  If these operations fail, buffer won't be toggled.
5755
5756 \end_layout
5757
5758 \begin_layout Description
5759 Syntax buffer-toggle-read-only
5760 \end_layout
5761
5762 \begin_layout Description
5763 Origin Lgb, 27 May 1997
5764 \end_layout
5765
5766 \begin_layout Subsection*
5767 LFUN_BUFFER_VIEW
5768 \end_layout
5769
5770 \begin_layout Description
5771 Action Displays current buffer in chosen format.
5772
5773 \end_layout
5774
5775 \begin_layout Description
5776 Notion Displays the contents of the current buffer in the chosen format,
5777  for example, PDF or DVI.
5778  This runs the necessary converter, calls the defined viewer, and so forth.
5779
5780 \end_layout
5781
5782 \begin_layout Description
5783 Syntax buffer-view <FORMAT>
5784 \end_layout
5785
5786 \begin_layout Description
5787 Params <FORMAT>: The format to display, where this is one of the formats
5788  defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
5789
5790 \end_layout
5791
5792 \begin_layout Subsection*
5793 LFUN_BUFFER_UPDATE
5794 \end_layout
5795
5796 \begin_layout Description
5797 Action Exports the current document and put the result into the temporary
5798  directory.
5799
5800 \end_layout
5801
5802 \begin_layout Description
5803 Notion In case you are already viewing the exported document (see LFUN_BUFFER_VI
5804 EW) the output will be rewriten - updated.
5805  This is useful in case your viewer is able to detect such changes (e.g.
5806  ghostview for postscript).
5807
5808 \end_layout
5809
5810 \begin_layout Description
5811 Syntax buffer-update <FORMAT>
5812 \end_layout
5813
5814 \begin_layout Description
5815 Params <FORMAT>: The format to display, where this is one of the formats
5816  defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
5817
5818 \end_layout
5819
5820 \begin_layout Description
5821 Origin Dekel, 5 Aug 2000
5822 \end_layout
5823
5824 \begin_layout Subsection*
5825 LFUN_BUFFER_WRITE
5826 \end_layout
5827
5828 \begin_layout Description
5829 Action Saves the current buffer.
5830
5831 \end_layout
5832
5833 \begin_layout Description
5834 Notion Saves the current buffer to disk, using the filename that is already
5835  associated with the buffer, asking for one if none is yet assigned.
5836
5837 \end_layout
5838
5839 \begin_layout Description
5840 Syntax buffer-write
5841 \end_layout
5842
5843 \begin_layout Subsection*
5844 LFUN_BUFFER_WRITE_AS
5845 \end_layout
5846
5847 \begin_layout Description
5848 Action Rename and save current buffer.
5849
5850 \end_layout
5851
5852 \begin_layout Description
5853 Syntax buffer-write-as <FILENAME>
5854 \end_layout
5855
5856 \begin_layout Description
5857 Params <FILENAME>: New name of the buffer/file.
5858  A relative path is with respect to the original location of the buffer/file.
5859
5860 \end_layout
5861
5862 \begin_layout Subsection*
5863 LFUN_BUFFER_WRITE_ALL
5864 \end_layout
5865
5866 \begin_layout Description
5867 Action Save all changed documents.
5868
5869 \end_layout
5870
5871 \begin_layout Description
5872 Syntax buffer-write-all
5873 \end_layout
5874
5875 \begin_layout Description
5876 Origin rgh, gpothier 6 Aug 2007
5877 \end_layout
5878
5879 \begin_layout Subsection*
5880 LFUN_BUFFER_NEXT
5881 \end_layout
5882
5883 \begin_layout Description
5884 Action Switch to the next opened document.
5885
5886 \end_layout
5887
5888 \begin_layout Description
5889 Notion Note that this does not necessarily mean next in tabbar (for full
5890  list see View menu).
5891
5892 \end_layout
5893
5894 \begin_layout Description
5895 Syntax buffer-next
5896 \end_layout
5897
5898 \begin_layout Subsection*
5899 LFUN_BUFFER_PREVIOUS
5900 \end_layout
5901
5902 \begin_layout Description
5903 Action Switch to the previous opened document.
5904
5905 \end_layout
5906
5907 \begin_layout Description
5908 Syntax buffer-previous
5909 \end_layout
5910
5911 \begin_layout Subsection*
5912 LFUN_MASTER_BUFFER_UPDATE
5913 \end_layout
5914
5915 \begin_layout Description
5916 Action When run from a child document, this updates (exports) document built
5917  from the master buffer.
5918  If a master is not found, it updates the current buffer.
5919
5920 \end_layout
5921
5922 \begin_layout Description
5923 Syntax master-buffer-update
5924 \end_layout
5925
5926 \begin_layout Description
5927 Origin Tommaso, 20 Sep 2007
5928 \end_layout
5929
5930 \begin_layout Subsection*
5931 LFUN_MASTER_BUFFER_VIEW
5932 \end_layout
5933
5934 \begin_layout Description
5935 Action When run from a child document, this command shows a preview built
5936  from the master buffer.
5937  If a master is not found, it previews the current buffer.
5938
5939 \end_layout
5940
5941 \begin_layout Description
5942 Syntax master-buffer-view
5943 \end_layout
5944
5945 \begin_layout Description
5946 Origin Tommaso, 20 Sep 2007
5947 \end_layout
5948
5949 \begin_layout Subsection*
5950 LFUN_BUFFER_LANGUAGE
5951 \end_layout
5952
5953 \begin_layout Description
5954 Action Set language of the current document.
5955
5956 \end_layout
5957
5958 \begin_layout Description
5959 Syntax buffer-language <LANG>
5960 \end_layout
5961
5962 \begin_layout Description
5963 Params <LANG>: language name.
5964  See lib/languages for list.
5965
5966 \end_layout
5967
5968 \begin_layout Description
5969 Origin leeming, 30 Mar 2004
5970 \end_layout
5971
5972 \begin_layout Subsection*
5973 LFUN_BUFFER_SAVE_AS_DEFAULT
5974 \end_layout
5975
5976 \begin_layout Description
5977 Action Save the current document settings as default.
5978
5979 \end_layout
5980
5981 \begin_layout Description
5982 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
5983
5984 \end_layout
5985
5986 \begin_layout Description
5987 Syntax buffer-save-as-default [<ARGS>]
5988 \end_layout
5989
5990 \begin_layout Description
5991 Params <ARGS>: contains the particular settings to be saved.
5992  They obey the syntax you can find in document header of usual .lyx file.
5993
5994 \end_layout
5995
5996 \begin_layout Description
5997 Origin leeming, 30 Mar 2004
5998 \end_layout
5999
6000 \begin_layout Subsection*
6001 LFUN_BUFFER_PARAMS_APPLY
6002 \end_layout
6003
6004 \begin_layout Description
6005 Action Apply the given settings to the current document.
6006
6007 \end_layout
6008
6009 \begin_layout Description
6010 Syntax buffer-params-apply [<ARGS>]
6011 \end_layout
6012
6013 \begin_layout Description
6014 Params <ARGS>: contains the particular settings to be saved.
6015  They obey the syntax you can find in document header of usual .lyx file.
6016
6017 \end_layout
6018
6019 \begin_layout Description
6020 Origin leeming, 30 Mar 2004
6021 \end_layout
6022
6023 \begin_layout Subsection*
6024 LFUN_FILE_INSERT
6025 \end_layout
6026
6027 \begin_layout Description
6028 Action Inserts another LyX file.
6029
6030 \end_layout
6031
6032 \begin_layout Description
6033 Syntax file-insert [<FILE>]
6034 \end_layout
6035
6036 \begin_layout Description
6037 Params <FILE>: Filename to be inserted.
6038
6039 \end_layout
6040
6041 \begin_layout Subsection*
6042 LFUN_FILE_INSERT_PLAINTEXT
6043 \end_layout
6044
6045 \begin_layout Description
6046 Action Inserts plain text file.
6047
6048 \end_layout
6049
6050 \begin_layout Description
6051 Syntax file-insert-plaintext [<FILE>]
6052 \end_layout
6053
6054 \begin_layout Description
6055 Params <FILE>: Filename to be inserted.
6056
6057 \end_layout
6058
6059 \begin_layout Description
6060 Origin CFO-G, 19 Nov 1997
6061 \end_layout
6062
6063 \begin_layout Subsection*
6064 LFUN_FILE_INSERT_PLAINTEXT_PARA
6065 \end_layout
6066
6067 \begin_layout Description
6068 Action Inserts plain text file as paragraph (i.e.
6069  join lines).
6070
6071 \end_layout
6072
6073 \begin_layout Description
6074 Syntax file-insert-plaintext-para [<FILE>]
6075 \end_layout
6076
6077 \begin_layout Description
6078 Params <FILE>: Filename to be inserted.
6079
6080 \end_layout
6081
6082 \begin_layout Description
6083 Origin Levon, 14 Feb 2001
6084 \end_layout
6085
6086 \begin_layout Subsection*
6087 LFUN_FILE_OPEN
6088 \end_layout
6089
6090 \begin_layout Description
6091 Action Open LyX document.
6092
6093 \end_layout
6094
6095 \begin_layout Description
6096 Syntax file-open [<FILE>]
6097 \end_layout
6098
6099 \begin_layout Description
6100 Params <FILE>: Filename to be opened.
6101
6102 \end_layout
6103
6104 \begin_layout Subsection*
6105 LFUN_CALL
6106 \end_layout
6107
6108 \begin_layout Description
6109 Action Executes a command defined in a .def file.
6110
6111 \end_layout
6112
6113 \begin_layout Description
6114 Notion The definitions are by default read from lib/commands/default.def.
6115
6116 \begin_inset Newline newline
6117 \end_inset
6118
6119  A .def file allows to define a command with
6120 \backslash
6121 define "<NAME>" "<LFUN>" where <NAME> is the name of the new command and
6122  <LFUN> is the lfun code to be executed (see e.g.
6123  LFUN_COMMAND_SEQUENCE).
6124
6125 \backslash
6126 def_file "FileName" allows to include another .def file.
6127
6128 \begin_inset Newline newline
6129 \end_inset
6130
6131  This is particularly useful in connection with toolbar buttons: Since the
6132  name of the button image for this lfun is lib/images/commands/<NAME>.png
6133  this is the way to assign an image to a complex command-sequence.
6134
6135 \end_layout
6136
6137 \begin_layout Description
6138 Syntax call <NAME>
6139 \end_layout
6140
6141 \begin_layout Description
6142 Params <NAME>: Name of the command that must be called.
6143
6144 \end_layout
6145
6146 \begin_layout Description
6147 Origin broider, 2 Oct 2007
6148 \end_layout
6149
6150 \begin_layout Subsection*
6151 LFUN_META_PREFIX
6152 \end_layout
6153
6154 \begin_layout Description
6155 Action Simulate halting Meta key (Alt key on PCs).
6156
6157 \end_layout
6158
6159 \begin_layout Description
6160 Notion Used for buffer editation not for GUI control.
6161
6162 \end_layout
6163
6164 \begin_layout Description
6165 Syntax meta-prefix
6166 \end_layout
6167
6168 \begin_layout Subsection*
6169 LFUN_CANCEL
6170 \end_layout
6171
6172 \begin_layout Description
6173 Action Cancels sequence prepared by LFUN_META_PREFIX .
6174
6175 \end_layout
6176
6177 \begin_layout Description
6178 Syntax cancel
6179 \end_layout
6180
6181 \begin_layout Subsection*
6182 LFUN_COMMAND_EXECUTE
6183 \end_layout
6184
6185 \begin_layout Description
6186 Action Opens the minibuffer toolbar so that the user can type in there.
6187
6188 \end_layout
6189
6190 \begin_layout Description
6191 Notion Usually bound to M-x shortcut.
6192
6193 \end_layout
6194
6195 \begin_layout Description
6196 Syntax command-execute
6197 \end_layout
6198
6199 \begin_layout Subsection*
6200 LFUN_COMMAND_PREFIX
6201 \end_layout
6202
6203 \begin_layout Description
6204 Action Return the current key sequence and available options as a string.
6205
6206 \end_layout
6207
6208 \begin_layout Description
6209 Notion No options are added if no current map exists.
6210
6211 \begin_inset Newline newline
6212 \end_inset
6213
6214  This is probably usable only with connection to lyxserver.
6215
6216 \end_layout
6217
6218 \begin_layout Description
6219 Syntax command-prefix
6220 \end_layout
6221
6222 \begin_layout Subsection*
6223 LFUN_COMMAND_SEQUENCE
6224 \end_layout
6225
6226 \begin_layout Description
6227 Action Run more commands (LFUN and its parameters) in a sequence.
6228
6229 \end_layout
6230
6231 \begin_layout Description
6232 Syntax command-sequence <CMDS>
6233 \end_layout
6234
6235 \begin_layout Description
6236 Params <CMDS>: Sequence of commands separated by semicolons.
6237
6238 \end_layout
6239
6240 \begin_layout Description
6241 Sample command-sequence cut; ert-insert; self-insert ; paste; self-insert
6242  {}; inset-toggle;
6243 \end_layout
6244
6245 \begin_layout Description
6246 Origin Andre, 11 Nov 1999
6247 \end_layout
6248
6249 \begin_layout Subsection*
6250 LFUN_COMMAND_ALTERNATIVES
6251 \end_layout
6252
6253 \begin_layout Description
6254 Action Runs the first listed command that is enabled.
6255
6256 \end_layout
6257
6258 \begin_layout Description
6259 Notion This can be used to bind multiple functions to a single key, and
6260  then which one is used will depend upon the context.
6261
6262 \end_layout
6263
6264 \begin_layout Description
6265 Syntax command-alternatives <CMDS>
6266 \end_layout
6267
6268 \begin_layout Description
6269 Params <CMDS>: Sequence of commands separated by semicolons.
6270
6271 \end_layout
6272
6273 \begin_layout Description
6274 Sample command-alternatives completion-accept;cell-forward
6275 \end_layout
6276
6277 \begin_layout Description
6278 Origin rgh, 24 September 2008
6279 \end_layout
6280
6281 \begin_layout Subsection*
6282 LFUN_MESSAGE
6283 \end_layout
6284
6285 \begin_layout Description
6286 Action Shows message in statusbar (for script purposes).
6287
6288 \end_layout
6289
6290 \begin_layout Description
6291 Syntax message <STRING>
6292 \end_layout
6293
6294 \begin_layout Description
6295 Origin Lgb, 8 Apr 2001
6296 \end_layout
6297
6298 \begin_layout Subsection*
6299 LFUN_PREFERENCES_SAVE
6300 \end_layout
6301
6302 \begin_layout Description
6303 Action Save user preferences.
6304
6305 \end_layout
6306
6307 \begin_layout Description
6308 Syntax preferences-save
6309 \end_layout
6310
6311 \begin_layout Description
6312 Origin Lgb, 27 Nov 1999
6313 \end_layout
6314
6315 \begin_layout Subsection*
6316 LFUN_RECONFIGURE
6317 \end_layout
6318
6319 \begin_layout Description
6320 Action Reconfigure the automatic settings.
6321
6322 \end_layout
6323
6324 \begin_layout Description
6325 Syntax reconfigure
6326 \end_layout
6327
6328 \begin_layout Description
6329 Origin Asger, 14 Feb 1997
6330 \end_layout
6331
6332 \begin_layout Subsection*
6333 LFUN_LYXRC_APPLY
6334 \end_layout
6335
6336 \begin_layout Description
6337 Action Apply the given settings to user preferences.
6338
6339 \end_layout
6340
6341 \begin_layout Description
6342 Syntax lyxrc-apply <SETTINGS>
6343 \end_layout
6344
6345 \begin_layout Description
6346 Params <SETTINGS>: settings which are to be set.
6347  Take a look into ~/.lyx/preferences to get an idea which commands to use
6348  and their syntax.
6349  lyx::LyXRC::LyXRCTags has the list of possible commands.
6350
6351 \end_layout
6352
6353 \begin_layout Subsection*
6354 LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
6355 \end_layout
6356
6357 \begin_layout Description
6358 Action Determine whether keep cursor inside the editing window regardless
6359  the scrollbar movement.
6360
6361 \end_layout
6362
6363 \begin_layout Description
6364 Syntax toggle-cursor-follows-scrollbar
6365 \end_layout
6366
6367 \begin_layout Description
6368 Origin ARRae, 2 Dec 1997
6369 \end_layout
6370
6371 \begin_layout Subsection*
6372 LFUN_SET_COLOR
6373 \end_layout
6374
6375 \begin_layout Description
6376 Action Set the given LyX color to the color defined by the X11 name given.
6377
6378 \end_layout
6379
6380 \begin_layout Description
6381 Notion A new color entry is created if the color is unknown.
6382  Color names can be stored as a part of user settings.
6383
6384 \end_layout
6385
6386 \begin_layout Description
6387 Syntax set-color <LYX_NAME> <X11_NAME>
6388 \end_layout
6389
6390 \begin_layout Description
6391 Origin SLior, 11 Jun 2000
6392 \end_layout
6393
6394 \begin_layout Subsection*
6395 LFUN_STATISTICS
6396 \end_layout
6397
6398 \begin_layout Description
6399 Action Count the statistics (number of words and characters) in the document
6400  or in the given selection.
6401
6402 \end_layout
6403
6404 \begin_layout Description
6405 Notion Note that this function gives the number of words/chars written,
6406  not the number of characters which will be typeset.
6407
6408 \end_layout
6409
6410 \begin_layout Description
6411 Syntax statistics
6412 \end_layout
6413
6414 \begin_layout Description
6415 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
6416 \end_layout
6417
6418 \begin_layout Subsection*
6419 LFUN_COMPLETION_INLINE
6420 \end_layout
6421
6422 \begin_layout Description
6423 Action Show the inline completion at the cursor position.
6424
6425 \end_layout
6426
6427 \begin_layout Description
6428 Syntax completion-inline
6429 \end_layout
6430
6431 \begin_layout Description
6432 Origin sts, Feb 19 2008
6433 \end_layout
6434
6435 \begin_layout Subsection*
6436 LFUN_COMPLETION_POPUP
6437 \end_layout
6438
6439 \begin_layout Description
6440 Action Show the completion popup at the cursor position.
6441
6442 \end_layout
6443
6444 \begin_layout Description
6445 Syntax completion-popup
6446 \end_layout
6447
6448 \begin_layout Description
6449 Origin sts, Feb 19 2008
6450 \end_layout
6451
6452 \begin_layout Subsection*
6453 LFUN_COMPLETION_COMPLETE
6454 \end_layout
6455
6456 \begin_layout Description
6457 Action Try to complete the word or command at the cursor position.
6458
6459 \end_layout
6460
6461 \begin_layout Description
6462 Syntax complete
6463 \end_layout
6464
6465 \begin_layout Description
6466 Origin sts, Feb 19 2008
6467 \end_layout
6468
6469 \begin_layout Subsection*
6470 LFUN_COMPLETION_CANCEL
6471 \end_layout
6472
6473 \begin_layout Description
6474 Action Try to cancel completion, either the popup or the inline completion
6475
6476 \end_layout
6477
6478 \begin_layout Description
6479 Syntax completion-cancel
6480 \end_layout
6481
6482 \begin_layout Description
6483 Origin sts, Sep 07 2008
6484 \end_layout
6485
6486 \begin_layout Subsection*
6487 LFUN_COMPLETION_ACCEPT
6488 \end_layout
6489
6490 \begin_layout Description
6491 Action Accept suggested completion.
6492
6493 \end_layout
6494
6495 \begin_layout Description
6496 Syntax completion-accept
6497 \end_layout
6498
6499 \begin_layout Description
6500 Origin sanda, Sep 08 2008
6501 \end_layout
6502
6503 \begin_layout Subsection*
6504 LFUN_BRANCH_ACTIVATE
6505 \end_layout
6506
6507 \begin_layout Description
6508 Action Activate the branch
6509 \end_layout
6510
6511 \begin_layout Description
6512 Syntax branch-activate <BRANCH>
6513 \end_layout
6514
6515 \begin_layout Description
6516 Params <BRANCH>: The branch to activate
6517 \end_layout
6518
6519 \begin_layout Description
6520 Sample lyx -e pdf2 -x "branch-activate answers" finalexam.lyx
6521 \begin_inset Newline newline
6522 \end_inset
6523
6524 could be used to export a pdf with the answers branch includedwithout one's
6525  having to open LyX and activate the branch manually.
6526 \end_layout
6527
6528 \begin_layout Description
6529 Origin rgh, 27 May 2008
6530 \end_layout
6531
6532 \begin_layout Subsection*
6533 LFUN_BRANCH_ACTIVATE
6534 \end_layout
6535
6536 \begin_layout Description
6537 Action De-activate the branch
6538 \end_layout
6539
6540 \begin_layout Description
6541 Syntax branch-deactivate <BRANCH>
6542 \end_layout
6543
6544 \begin_layout Description
6545 Params <BRANCH>: The branch to deactivate
6546 \end_layout
6547
6548 \begin_layout Description
6549 Origin rgh, 27 May 2008
6550 \end_layout
6551
6552 \end_body
6553 \end_document