lib/doc/LFUNs.lyx

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