lib/doc/LFUNs.lyx

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