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 23.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_SELECTION_PASTE
2058 \end_layout
2059
2060 \begin_layout Description
2061 Action Pastes the text in permanent selection.
2062
2063 \end_layout
2064
2065 \begin_layout Description
2066 Syntax selection-paste
2067 \end_layout
2068
2069 \begin_layout Subsection*
2070 LFUN_UNDO
2071 \end_layout
2072
2073 \begin_layout Description
2074 Action Undoes the last edit.
2075
2076 \end_layout
2077
2078 \begin_layout Description
2079 Syntax undo
2080 \end_layout
2081
2082 \begin_layout Subsection*
2083 LFUN_REDO
2084 \end_layout
2085
2086 \begin_layout Description
2087 Action Redoes the last thing undone.
2088
2089 \end_layout
2090
2091 \begin_layout Description
2092 Syntax redo
2093 \end_layout
2094
2095 \begin_layout Subsection*
2096 LFUN_REPEAT
2097 \end_layout
2098
2099 \begin_layout Description
2100 Action Repeat the given command.
2101
2102 \end_layout
2103
2104 \begin_layout Description
2105 Syntax repeat <COUNT> <LFUN-COMMAND>
2106 \end_layout
2107
2108 \begin_layout Description
2109 Origin Andre, , 27 Oct 2003
2110 \end_layout
2111
2112 \begin_layout Subsection*
2113 LFUN_CHARS_TRANSPOSE
2114 \end_layout
2115
2116 \begin_layout Description
2117 Action Transposes the character at the cursor with the one before it.
2118
2119 \end_layout
2120
2121 \begin_layout Description
2122 Syntax chars-transpose
2123 \end_layout
2124
2125 \begin_layout Description
2126 Origin Lgb, 25 Apr 2001
2127 \end_layout
2128
2129 \begin_layout Subsection*
2130 LFUN_DEPTH_DECREMENT
2131 \end_layout
2132
2133 \begin_layout Description
2134 Action Decrease the nesting depth of the (selected) paragraph(s) inside
2135  lists.
2136
2137 \end_layout
2138
2139 \begin_layout Description
2140 Syntax depth-decrement
2141 \end_layout
2142
2143 \begin_layout Subsection*
2144 LFUN_DEPTH_INCREMENT
2145 \end_layout
2146
2147 \begin_layout Description
2148 Action Increase the nesting depth of the (selected) paragraph(s) inside
2149  lists.
2150
2151 \end_layout
2152
2153 \begin_layout Description
2154 Syntax depth-increment
2155 \end_layout
2156
2157 \begin_layout Subsection*
2158 LFUN_FONT_BOLD
2159 \end_layout
2160
2161 \begin_layout Description
2162 Action Toggles the bold font (selection-wise) using mathbf in math.
2163
2164 \end_layout
2165
2166 \begin_layout Description
2167 Syntax font-bold
2168 \end_layout
2169
2170 \begin_layout Subsection*
2171 LFUN_FONT_BOLDSYMBOL
2172 \end_layout
2173
2174 \begin_layout Description
2175 Action Toggles the bold font (selection-wise) using boldsymbol in math.
2176
2177 \end_layout
2178
2179 \begin_layout Description
2180 Syntax font-boldsymbol
2181 \end_layout
2182
2183 \begin_layout Subsection*
2184 LFUN_FONT_TYPEWRITER
2185 \end_layout
2186
2187 \begin_layout Description
2188 Action Toggles the typewriter family font (selection-wise).
2189
2190 \end_layout
2191
2192 \begin_layout Description
2193 Syntax font-typewriter
2194 \end_layout
2195
2196 \begin_layout Subsection*
2197 LFUN_FONT_UNDERLINE
2198 \end_layout
2199
2200 \begin_layout Description
2201 Action Toggles underline in the font (selection-wise).
2202
2203 \end_layout
2204
2205 \begin_layout Description
2206 Syntax font-underline
2207 \end_layout
2208
2209 \begin_layout Subsection*
2210 LFUN_FONT_EMPH
2211 \end_layout
2212
2213 \begin_layout Description
2214 Action Toggles the emphasis font style (selection-wise).
2215
2216 \end_layout
2217
2218 \begin_layout Description
2219 Syntax font-emph
2220 \end_layout
2221
2222 \begin_layout Subsection*
2223 LFUN_FONT_NOUN
2224 \end_layout
2225
2226 \begin_layout Description
2227 Action Toggles Noun text style font (selection-wise).
2228
2229 \end_layout
2230
2231 \begin_layout Description
2232 Syntax font-noun
2233 \end_layout
2234
2235 \begin_layout Subsection*
2236 LFUN_FONT_ROMAN
2237 \end_layout
2238
2239 \begin_layout Description
2240 Action Toggles Roman family font (selection-wise).
2241
2242 \end_layout
2243
2244 \begin_layout Description
2245 Syntax font-roman
2246 \end_layout
2247
2248 \begin_layout Subsection*
2249 LFUN_FONT_SANS
2250 \end_layout
2251
2252 \begin_layout Description
2253 Action Toggles Sans Serif family font (selection-wise).
2254
2255 \end_layout
2256
2257 \begin_layout Description
2258 Syntax font-sans
2259 \end_layout
2260
2261 \begin_layout Subsection*
2262 LFUN_FONT_FRAK
2263 \end_layout
2264
2265 \begin_layout Description
2266 Action Toggles Fraktur family font (math-mode, selection-wise).
2267
2268 \end_layout
2269
2270 \begin_layout Description
2271 Syntax font-frak
2272 \end_layout
2273
2274 \begin_layout Description
2275 Origin vermeer, 10 Jan 2002
2276 \end_layout
2277
2278 \begin_layout Subsection*
2279 LFUN_FONT_ITAL
2280 \end_layout
2281
2282 \begin_layout Description
2283 Action Toggles Italics font shape (math-mode, selection-wise).
2284
2285 \end_layout
2286
2287 \begin_layout Description
2288 Syntax font-ital
2289 \end_layout
2290
2291 \begin_layout Description
2292 Origin vermeer, 10 Jan 2002
2293 \end_layout
2294
2295 \begin_layout Subsection*
2296 LFUN_FONT_DEFAULT
2297 \end_layout
2298
2299 \begin_layout Description
2300 Action Reverts the settings of the font to the default values (selection-wise).
2301
2302 \end_layout
2303
2304 \begin_layout Description
2305 Syntax font-default
2306 \end_layout
2307
2308 \begin_layout Subsection*
2309 LFUN_FONT_SIZE
2310 \end_layout
2311
2312 \begin_layout Description
2313 Action Sets font size according to lyx format string.
2314
2315 \end_layout
2316
2317 \begin_layout Description
2318 Syntax font-size <SIZE>
2319 \end_layout
2320
2321 \begin_layout Description
2322 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
2323 \begin_inset Newline newline
2324 \end_inset
2325
2326  largest|huge|giant|increase|decrease|default
2327 \end_layout
2328
2329 \begin_layout Subsection*
2330 LFUN_TEXTSTYLE_APPLY
2331 \end_layout
2332
2333 \begin_layout Description
2334 Action Toggle user-defined (=last-time used) text style.
2335
2336 \end_layout
2337
2338 \begin_layout Description
2339 Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically
2340  trigerred when using Text Style dialog.
2341
2342 \end_layout
2343
2344 \begin_layout Description
2345 Syntax textstyle-apply
2346 \end_layout
2347
2348 \begin_layout Description
2349 Origin leeming, 12 Mar 2003
2350 \end_layout
2351
2352 \begin_layout Subsection*
2353 LFUN_TEXTSTYLE_UPDATE
2354 \end_layout
2355
2356 \begin_layout Description
2357 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APP
2358 LY.
2359
2360 \end_layout
2361
2362 \begin_layout Description
2363 Syntax textstyle-update <FONT_INFO>
2364 \end_layout
2365
2366 \begin_layout Description
2367 Params <FONT_INFO>: specifies font atributes, e.g.
2368  family, series, shape, size, emph, noun, underbar, number, color, language,
2369  toggleall.
2370
2371 \begin_inset Newline newline
2372 \end_inset
2373
2374  Use lyx -dbg action for exact syntax of text-style dialog parameters.
2375
2376 \end_layout
2377
2378 \begin_layout Description
2379 Origin leeming, 12 Mar 2003
2380 \end_layout
2381
2382 \begin_layout Subsection*
2383 LFUN_SCREEN_FONT_UPDATE
2384 \end_layout
2385
2386 \begin_layout Description
2387 Action Update fonts and its metrics.
2388
2389 \end_layout
2390
2391 \begin_layout Description
2392 Notion Automatically called after zoom, dpi, font names, or norm change.
2393
2394 \end_layout
2395
2396 \begin_layout Description
2397 Syntax screen-font-update
2398 \end_layout
2399
2400 \begin_layout Description
2401 Origin ARRae, 13 Aug 2000
2402 \end_layout
2403
2404 \begin_layout Subsection*
2405 LFUN_FONT_STATE
2406 \end_layout
2407
2408 \begin_layout Description
2409 Action Returns the info about the current font.
2410
2411 \end_layout
2412
2413 \begin_layout Description
2414 Syntax font-state
2415 \end_layout
2416
2417 \begin_layout Subsection*
2418 LFUN_CITATION_INSERT
2419 \end_layout
2420
2421 \begin_layout Description
2422 Action Inserts citation from loaded citation database.
2423
2424 \end_layout
2425
2426 \begin_layout Description
2427 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
2428 \end_layout
2429
2430 \begin_layout Description
2431 Params <KEY>: Citation (shortcut listed in available citations).
2432
2433 \begin_inset Newline newline
2434 \end_inset
2435
2436  <TEXT_BEFORE>: text which should appear before citation.
2437
2438 \end_layout
2439
2440 \begin_layout Description
2441 Origin AAS, 97-02-23
2442 \end_layout
2443
2444 \begin_layout Subsection*
2445 LFUN_BIBTEX_DATABASE_ADD
2446 \end_layout
2447
2448 \begin_layout Description
2449 Action Adds database, which will be used for bibtex citations.
2450
2451 \end_layout
2452
2453 \begin_layout Description
2454 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX
2455  bibliography) found from the cursor postion.
2456
2457 \end_layout
2458
2459 \begin_layout Description
2460 Syntax bibtex-database-add <DATABASE-NAME>
2461 \end_layout
2462
2463 \begin_layout Description
2464 Origin Ale, 30 May 1997
2465 \end_layout
2466
2467 \begin_layout Subsection*
2468 LFUN_BIBTEX_DATABASE_DEL
2469 \end_layout
2470
2471 \begin_layout Description
2472 Action Adds database, which will be used for bibtex citations.
2473
2474 \end_layout
2475
2476 \begin_layout Description
2477 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTe
2478 X bibliography) found from the cursor postion.
2479
2480 \end_layout
2481
2482 \begin_layout Description
2483 Syntax bibtex-database-del <DATABASE-NAME>
2484 \end_layout
2485
2486 \begin_layout Description
2487 Origin Ale, 30 May 1997
2488 \end_layout
2489
2490 \begin_layout Subsection*
2491 LFUN_LAYOUT
2492 \end_layout
2493
2494 \begin_layout Description
2495 Action Sets the layout (that is, environment) for the current paragraph.
2496
2497 \end_layout
2498
2499 \begin_layout Description
2500 Syntax layout <LAYOUT>
2501 \end_layout
2502
2503 \begin_layout Description
2504 Params <LAYOUT>: the layout to use
2505 \end_layout
2506
2507 \begin_layout Subsection*
2508 LFUN_LAYOUT_PARAGRAPH
2509 \end_layout
2510
2511 \begin_layout Description
2512 Action Launches the paragraph settings dialog.
2513
2514 \end_layout
2515
2516 \begin_layout Description
2517 Syntax layout-paragraph
2518 \end_layout
2519
2520 \begin_layout Subsection*
2521 LFUN_LAYOUT_TABULAR
2522 \end_layout
2523
2524 \begin_layout Description
2525 Action Launches the tabular settings dialog.
2526
2527 \end_layout
2528
2529 \begin_layout Description
2530 Syntax layout-tabular
2531 \end_layout
2532
2533 \begin_layout Description
2534 Origin Jug, 31 Jul 2000
2535 \end_layout
2536
2537 \begin_layout Subsection*
2538 LFUN_DROP_LAYOUTS_CHOICE
2539 \end_layout
2540
2541 \begin_layout Description
2542 Action Displays list of layout choices.
2543
2544 \end_layout
2545
2546 \begin_layout Description
2547 Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox
2548  allowing for choice of layout.
2549
2550 \end_layout
2551
2552 \begin_layout Description
2553 Syntax drop-layouts-choice
2554 \end_layout
2555
2556 \begin_layout Subsection*
2557 LFUN_LAYOUT_MODULES_CLEAR
2558 \end_layout
2559
2560 \begin_layout Description
2561 Action Clears the module list.
2562
2563 \end_layout
2564
2565 \begin_layout Description
2566 Notion Clears the list of included modules for the current buffer.
2567
2568 \end_layout
2569
2570 \begin_layout Description
2571 Syntax layout-modules-clear
2572 \end_layout
2573
2574 \begin_layout Description
2575 Origin rgh, 25 August 2007
2576 \end_layout
2577
2578 \begin_layout Subsection*
2579 LFUN_LAYOUT_MODULE_ADD
2580 \end_layout
2581
2582 \begin_layout Description
2583 Action Adds a module.
2584
2585 \end_layout
2586
2587 \begin_layout Description
2588 Notion Adds a module to the list of included modules for the current buffer.
2589
2590 \end_layout
2591
2592 \begin_layout Description
2593 Syntax layout-module-add <MODULE>
2594 \end_layout
2595
2596 \begin_layout Description
2597 Params <MODULE>: the module to be added
2598 \end_layout
2599
2600 \begin_layout Description
2601 Origin rgh, 25 August 2007
2602 \end_layout
2603
2604 \begin_layout Subsection*
2605 LFUN_LAYOUT_RELOAD
2606 \end_layout
2607
2608 \begin_layout Description
2609 Action Reloads layout information.
2610
2611 \end_layout
2612
2613 \begin_layout Description
2614 Notion Reloads all layout information for the current buffer from disk,
2615  thus recognizing any changes that have been made to layout files on the
2616  fly.
2617  This is intended to be used only by layout developers and should not be
2618  used when one is trying to do actual work.
2619
2620 \end_layout
2621
2622 \begin_layout Description
2623 Syntax layout-reload
2624 \end_layout
2625
2626 \begin_layout Description
2627 Origin rgh, 3 September 2007
2628 \end_layout
2629
2630 \begin_layout Subsection*
2631 LFUN_TEXTCLASS_APPLY
2632 \end_layout
2633
2634 \begin_layout Description
2635 Action Sets the text class for the current buffer.
2636
2637 \end_layout
2638
2639 \begin_layout Description
2640 Syntax textclass-apply <TEXTCLASS>
2641 \end_layout
2642
2643 \begin_layout Description
2644 Params <TEXTCLASS>: the textclass to set.
2645  Note that this must be the filename, minus the ".layout" extension.
2646
2647 \end_layout
2648
2649 \begin_layout Subsection*
2650 LFUN_TEXTCLASS_LOAD
2651 \end_layout
2652
2653 \begin_layout Description
2654 Action Loads information for a textclass from disk.
2655
2656 \end_layout
2657
2658 \begin_layout Description
2659 Syntax textclass-load <TEXTCLASS>
2660 \end_layout
2661
2662 \begin_layout Description
2663 Params <TEXTCLASS>: the textclass to load.
2664  Note that this must be the filename, minus the ".layout" extension.
2665
2666 \end_layout
2667
2668 \begin_layout Subsection*
2669 LFUN_MARK_OFF
2670 \end_layout
2671
2672 \begin_layout Description
2673 Action Disable selecting of text-region.
2674
2675 \end_layout
2676
2677 \begin_layout Description
2678 Syntax mark-off
2679 \end_layout
2680
2681 \begin_layout Subsection*
2682 LFUN_MARK_ON
2683 \end_layout
2684
2685 \begin_layout Description
2686 Action Enable selecting of text-region.
2687
2688 \end_layout
2689
2690 \begin_layout Description
2691 Notion After enabling you can simply move arrow keys to get selected region.
2692
2693 \end_layout
2694
2695 \begin_layout Description
2696 Syntax mark-on
2697 \end_layout
2698
2699 \begin_layout Subsection*
2700 LFUN_MARK_TOGGLE
2701 \end_layout
2702
2703 \begin_layout Description
2704 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
2705
2706 \end_layout
2707
2708 \begin_layout Description
2709 Syntax mark-toggle
2710 \end_layout
2711
2712 \begin_layout Description
2713 Origin Andre, May 5 2006
2714 \end_layout
2715
2716 \begin_layout Subsection*
2717 LFUN_MATH_DELIM
2718 \end_layout
2719
2720 \begin_layout Description
2721 Action Inserts math delimiters (e.g.
2722  parentheses, brackets) enclosing expression.
2723
2724 \end_layout
2725
2726 \begin_layout Description
2727 Syntax math-delim [<LEFT>] [<RIGHT>]
2728 \end_layout
2729
2730 \begin_layout Description
2731 Params <LEFT/RIGHT>: Delimiters to be used.
2732  Each delimiter can be specified by either a LaTeX name or a valid character.
2733  ( is the default letter.
2734
2735 \end_layout
2736
2737 \begin_layout Description
2738 Sample math-delim { rangle
2739 \end_layout
2740
2741 \begin_layout Description
2742 Origin Alejandro, 18 Jun 1996
2743 \end_layout
2744
2745 \begin_layout Subsection*
2746 LFUN_MATH_BIGDELIM
2747 \end_layout
2748
2749 \begin_layout Description
2750 Action Inserts math fixed size delimiters (e.g.
2751  parentheses, brackets) enclosing expression.
2752
2753 \end_layout
2754
2755 \begin_layout Description
2756 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
2757 \end_layout
2758
2759 \begin_layout Description
2760 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
2761 \begin_inset Newline newline
2762 \end_inset
2763
2764  <L/RDELIM>: TeX code for delimiter.
2765  See Delimiter dialog for delimiters to be used.
2766
2767 \end_layout
2768
2769 \begin_layout Description
2770 Sample math-bigdelim "Bigl" "Downarrow" "Bigr" "}"
2771 \end_layout
2772
2773 \begin_layout Description
2774 Origin Enrico & Georg, 7 May 2006
2775 \end_layout
2776
2777 \begin_layout Subsection*
2778 LFUN_MATH_DISPLAY
2779 \end_layout
2780
2781 \begin_layout Description
2782 Action Creates a new displayed equation in text mode.
2783  Toggles inlined/display formula in math mode.
2784
2785 \end_layout
2786
2787 \begin_layout Description
2788 Syntax math-display [<ARG>]
2789 \end_layout
2790
2791 \begin_layout Description
2792 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating
2793  new equation from the text mode.
2794
2795 \end_layout
2796
2797 \begin_layout Description
2798 Origin Alejandro, 18 Jun 1996
2799 \end_layout
2800
2801 \begin_layout Subsection*
2802 LFUN_MATH_INSERT
2803 \end_layout
2804
2805 \begin_layout Description
2806 Action Inserts math objects and symbols.
2807
2808 \end_layout
2809
2810 \begin_layout Description
2811 Syntax math-insert <ARG>
2812 \end_layout
2813
2814 \begin_layout Description
2815 Params <ARG>: Symbol or LaTeX code to be inserted.
2816
2817 \end_layout
2818
2819 \begin_layout Subsection*
2820 LFUN_MATH_SUBSCRIPT
2821 \end_layout
2822
2823 \begin_layout Description
2824 Action Enters subscript expression in math expression.
2825
2826 \end_layout
2827
2828 \begin_layout Description
2829 Syntax math-subscript
2830 \end_layout
2831
2832 \begin_layout Description
2833 Origin vermeer, 12 Dec 2001
2834 \end_layout
2835
2836 \begin_layout Subsection*
2837 LFUN_MATH_SUPERSCRIPT
2838 \end_layout
2839
2840 \begin_layout Description
2841 Action Enters subscript expression in math expression.
2842
2843 \end_layout
2844
2845 \begin_layout Description
2846 Syntax math-superscript
2847 \end_layout
2848
2849 \begin_layout Description
2850 Origin vermeer, 12 Dec 2001
2851 \end_layout
2852
2853 \begin_layout Subsection*
2854 LFUN_MATH_LIMITS
2855 \end_layout
2856
2857 \begin_layout Description
2858 Action Toggles the position of the limits from above/below to the right
2859  side an vice versa in integral symbol, a limit, a summation, etc.
2860
2861 \end_layout
2862
2863 \begin_layout Description
2864 Notion Put the cursor before the symbol with the limits and then invoke
2865  math-limits.
2866
2867 \end_layout
2868
2869 \begin_layout Description
2870 Syntax math-limits [<STATE>]
2871 \end_layout
2872
2873 \begin_layout Description
2874 Params <STATE>: limits|nolimits
2875 \end_layout
2876
2877 \begin_layout Subsection*
2878 LFUN_MATH_MACRO
2879 \end_layout
2880
2881 \begin_layout Description
2882 Action Inserts a math macro definition at the cursor position in the text.
2883
2884 \end_layout
2885
2886 \begin_layout Description
2887 Syntax math-macro <NAME> [<NARGS>] [def]
2888 \end_layout
2889
2890 \begin_layout Description
2891 Params <NAME>: The name of the macro, e.g.
2892  "mymacro".
2893  <NARGS>: The number of parameters of the macro.
2894  Default is 0.
2895  "def": Has no effect anymore, just for compatibility with former LyX versions.
2896
2897 \end_layout
2898
2899 \begin_layout Description
2900 Origin ale, 10 May 1997;  sts, 21 Dec 2007
2901 \end_layout
2902
2903 \begin_layout Subsection*
2904 LFUN_MATH_MUTATE
2905 \end_layout
2906
2907 \begin_layout Description
2908 Action Mutates the type of math inset to the newly selected one.
2909
2910 \end_layout
2911
2912 \begin_layout Description
2913 Syntax math-mutate <TYPE>
2914 \end_layout
2915
2916 \begin_layout Description
2917 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
2918  multline|gather|flalign
2919 \end_layout
2920
2921 \begin_layout Description
2922 Origin Andre, 23 May 2001
2923 \end_layout
2924
2925 \begin_layout Subsection*
2926 LFUN_MATH_SPACE
2927 \end_layout
2928
2929 \begin_layout Description
2930 Action Inserts space into math expression.
2931
2932 \end_layout
2933
2934 \begin_layout Description
2935 Notion Use spacebar after entering this space to change type of space.
2936
2937 \end_layout
2938
2939 \begin_layout Description
2940 Syntax math-space [<TYPE>] [<LEN>]
2941 \end_layout
2942
2943 \begin_layout Description
2944 Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
2945
2946 \begin_inset Newline newline
2947 \end_inset
2948
2949  positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
2950
2951 \begin_inset Newline newline
2952 \end_inset
2953
2954  custom space: hspace
2955 \begin_inset Newline newline
2956 \end_inset
2957
2958  "," used by default.
2959  Note that ! is equivalent to negthinspace, , = thinspace, : = medspace,
2960  and ; = thickspace.
2961  <LEN>: length for custom spaces (hspace)
2962 \end_layout
2963
2964 \begin_layout Description
2965 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
2966 \end_layout
2967
2968 \begin_layout Subsection*
2969 LFUN_MATH_MATRIX
2970 \end_layout
2971
2972 \begin_layout Description
2973 Action Inserts a matrix.
2974
2975 \end_layout
2976
2977 \begin_layout Description
2978 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
2979 \end_layout
2980
2981 \begin_layout Description
2982 Params <ALIGN>: Alignment is a word composed of the vertical alignment (b,
2983  c or t) (i.e.
2984  1 char) and the horizontal alignments (l, c or r) (i.e.
2985  <COL> chars).
2986
2987 \end_layout
2988
2989 \begin_layout Description
2990 Sample math-matrix 3 3 bccc
2991 \end_layout
2992
2993 \begin_layout Subsection*
2994 LFUN_MATH_MODE
2995 \end_layout
2996
2997 \begin_layout Description
2998 Action In text mode enters math mode (i.e.
2999  puts math insets on the current cursor position), in math mode enters text
3000  mode inside math expression.
3001
3002 \end_layout
3003
3004 \begin_layout Description
3005 Notion If there is some selected text, it puts the text inside created math
3006  box.
3007
3008 \end_layout
3009
3010 \begin_layout Description
3011 Syntax math-mode [<ARG>]
3012 \end_layout
3013
3014 \begin_layout Description
3015 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT
3016  .
3017
3018 \end_layout
3019
3020 \begin_layout Description
3021 Origin Alejandro, 4 Jun 1996
3022 \end_layout
3023
3024 \begin_layout Subsection*
3025 LFUN_REGEXP_MODE
3026 \end_layout
3027
3028 \begin_layout Description
3029 Action Enters regexp mode (i.e., puts regexp insets on the current cursor
3030  position).
3031  Used by the advanced search dialog.
3032
3033 \end_layout
3034
3035 \begin_layout Description
3036 Notion If there is any selected text, then it is moved inside the created
3037  regexp inset.
3038
3039 \end_layout
3040
3041 \begin_layout Description
3042 Syntax regexp-mode [<ARG>]
3043 \end_layout
3044
3045 \begin_layout Description
3046 Params <ARG>: eventual argument (regular expression).
3047
3048 \end_layout
3049
3050 \begin_layout Description
3051 Origin Tommaso, 4 Oct 2008
3052 \end_layout
3053
3054 \begin_layout Subsection*
3055 LFUN_MATH_NUMBER_LINE_TOGGLE
3056 \end_layout
3057
3058 \begin_layout Description
3059 Action Toggles numbering of the current formula line.
3060
3061 \end_layout
3062
3063 \begin_layout Description
3064 Notion Must be in display formula mode.
3065
3066 \end_layout
3067
3068 \begin_layout Description
3069 Syntax math-number-line-toggle
3070 \end_layout
3071
3072 \begin_layout Description
3073 Origin Alejandro, 18 Jun 1996
3074 \end_layout
3075
3076 \begin_layout Subsection*
3077 LFUN_MATH_NUMBER_TOGGLE
3078 \end_layout
3079
3080 \begin_layout Description
3081 Action Toggles numbering/labeling of the current formula.
3082
3083 \end_layout
3084
3085 \begin_layout Description
3086 Notion Must be in display formula mode.
3087
3088 \end_layout
3089
3090 \begin_layout Description
3091 Syntax math-number-toggle
3092 \end_layout
3093
3094 \begin_layout Description
3095 Origin Alejandro, 4 Jun 1996
3096 \end_layout
3097
3098 \begin_layout Subsection*
3099 LFUN_MATH_EXTERN
3100 \end_layout
3101
3102 \begin_layout Description
3103 Action Calls external program and passes the current expression/equation
3104  as an argument for the calculation in the format appropriate to the given
3105  language.
3106
3107 \end_layout
3108
3109 \begin_layout Description
3110 Notion Selection can be used to determine the input for the external program.
3111
3112 \end_layout
3113
3114 \begin_layout Description
3115 Syntax math-extern <LANG> [<COMMAND>]
3116 \end_layout
3117
3118 \begin_layout Description
3119 Params <LANG>: octave|maxima|maple|mathematica|script
3120 \begin_inset Newline newline
3121 \end_inset
3122
3123  where "script" stands fot the external script (normalized expression will
3124  be passed)
3125 \end_layout
3126
3127 \begin_layout Description
3128 Origin Andre, 24 Apr 2001
3129 \end_layout
3130
3131 \begin_layout Description
3132 Sample math-extern maple simplify
3133 \end_layout
3134
3135 \begin_layout Subsection*
3136 LFUN_MATH_SIZE
3137 \end_layout
3138
3139 \begin_layout Description
3140 Action Changes arbitrarily the size used by math fonts inside a context.
3141
3142 \end_layout
3143
3144 \begin_layout Description
3145 Notion Provides an interface to the LaTeX math mode font size commands.
3146
3147 \end_layout
3148
3149 \begin_layout Description
3150 Syntax math-size <STYLE>
3151 \end_layout
3152
3153 \begin_layout Description
3154 Params <STYLE>: displaystyle|
3155 \backslash
3156 textstyle|
3157 \backslash
3158 scriptstyle|
3159 \backslash
3160 scriptscriptstyle
3161 \end_layout
3162
3163 \begin_layout Description
3164 Origin Alejandro, 15 Aug 1996; ps, 14 Jun 2008
3165 \end_layout
3166
3167 \begin_layout Subsection*
3168 LFUN_MATH_FONT_STYLE
3169 \end_layout
3170
3171 \begin_layout Description
3172 Action Changes the text style used in math.
3173
3174 \end_layout
3175
3176 \begin_layout Description
3177 Syntax math-font-style <STYLE>
3178 \end_layout
3179
3180 \begin_layout Description
3181 Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf |textnormal|tex
3182 trm|textsf|texttt|textbf|textmd|textit |textsc|textsl|textup
3183 \end_layout
3184
3185 \begin_layout Description
3186 Origin vfr, 9 jan 2009
3187 \end_layout
3188
3189 \begin_layout Subsection*
3190 LFUN_MATH_MACRO_UNFOLD
3191 \end_layout
3192
3193 \begin_layout Description
3194 Action Unfold a Math Macro.
3195
3196 \end_layout
3197
3198 \begin_layout Description
3199 Notion Unfold the Math Macro the cursor is in, i.e.
3200  display it as foo.
3201
3202 \end_layout
3203
3204 \begin_layout Description
3205 Syntax math-macro-unfold
3206 \end_layout
3207
3208 \begin_layout Description
3209 Origin sts, 06 January 2008
3210 \end_layout
3211
3212 \begin_layout Subsection*
3213 LFUN_MATH_MACRO_FOLD
3214 \end_layout
3215
3216 \begin_layout Description
3217 Action Fold a Math Macro.
3218
3219 \end_layout
3220
3221 \begin_layout Description
3222 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e.
3223  displayed as foo before.
3224
3225 \end_layout
3226
3227 \begin_layout Description
3228 Syntax math-macro-fold
3229 \end_layout
3230
3231 \begin_layout Description
3232 Origin sts, 06 January 2008
3233 \end_layout
3234
3235 \begin_layout Subsection*
3236 LFUN_MATH_MACRO_ADD_PARAM
3237 \end_layout
3238
3239 \begin_layout Description
3240 Action Add a parameter.
3241
3242 \end_layout
3243
3244 \begin_layout Description
3245 Notion Add a parameter to a Math Macro.
3246
3247 \end_layout
3248
3249 \begin_layout Description
3250 Params <NUM>: The number of the parameter behind which the new one will
3251  be added (1 for the first, i.e.
3252  use 0 for add a parameter at the left), defaults to the last one.
3253
3254 \end_layout
3255
3256 \begin_layout Description
3257 Syntax math-macro-add-param <NUM>
3258 \end_layout
3259
3260 \begin_layout Description
3261 Origin sts, 06 January 2008
3262 \end_layout
3263
3264 \begin_layout Subsection*
3265 LFUN_MATH_MACRO_REMOVE_PARAM
3266 \end_layout
3267
3268 \begin_layout Description
3269 Action Remove the last parameter.
3270
3271 \end_layout
3272
3273 \begin_layout Description
3274 Notion Remove the last parameter of a Math Macro and remove its value in
3275  all instances of the macro in the buffer.
3276
3277 \end_layout
3278
3279 \begin_layout Description
3280 Params <NUM>: The number of the parameter to be deleted (1 for the first),
3281  defaults to the last one.
3282
3283 \end_layout
3284
3285 \begin_layout Description
3286 Syntax math-macro-remove-param <NUM>
3287 \end_layout
3288
3289 \begin_layout Description
3290 Origin sts, 06 January 2008
3291 \end_layout
3292
3293 \begin_layout Subsection*
3294 LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
3295 \end_layout
3296
3297 \begin_layout Description
3298 Action Append a greedy parameter.
3299
3300 \end_layout
3301
3302 \begin_layout Description
3303 Notion Append a greedy parameter to a Math Macro which eats the following
3304  mathed cell in every instance of the macro in the buffer.
3305
3306 \end_layout
3307
3308 \begin_layout Description
3309 Syntax math-macro-append-greedy-param
3310 \end_layout
3311
3312 \begin_layout Description
3313 Origin sts, 06 January 2008
3314 \end_layout
3315
3316 \begin_layout Subsection*
3317 LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
3318 \end_layout
3319
3320 \begin_layout Description
3321 Action Remove a greedy parameter.
3322
3323 \end_layout
3324
3325 \begin_layout Description
3326 Notion Remove a greedy parameter of a Math Macro and spit out the values
3327  of it in every instance of the macro in the buffer.
3328  If it is an optional parameter the [valud] format is used.
3329
3330 \end_layout
3331
3332 \begin_layout Description
3333 Syntax math-macro-remove-greedy-param
3334 \end_layout
3335
3336 \begin_layout Description
3337 Origin sts, 06 January 2008
3338 \end_layout
3339
3340 \begin_layout Subsection*
3341 LFUN_MATH_MACRO_MAKE_OPTIONAL
3342 \end_layout
3343
3344 \begin_layout Description
3345 Action Make a parameter optional.
3346
3347 \end_layout
3348
3349 \begin_layout Description
3350 Notion Turn the first non-optional parameter of a Math Macro into an optional
3351  parameter with a default value.
3352
3353 \end_layout
3354
3355 \begin_layout Description
3356 Syntax math-macro-make-optional
3357 \end_layout
3358
3359 \begin_layout Description
3360 Origin sts, 06 January 2008
3361 \end_layout
3362
3363 \begin_layout Subsection*
3364 LFUN_MATH_MACRO_MAKE_NONOPTIONAL
3365 \end_layout
3366
3367 \begin_layout Description
3368 Action Make a parameter non-optional.
3369
3370 \end_layout
3371
3372 \begin_layout Description
3373 Notion Turn the last optional parameter of a Math Macro into a non-optional
3374  parameter.
3375  The default value is remembered to be reused later if the user changes
3376  his mind.
3377
3378 \end_layout
3379
3380 \begin_layout Description
3381 Syntax math-macro-make-nonoptional
3382 \end_layout
3383
3384 \begin_layout Description
3385 Origin sts, 06 January 2008
3386 \end_layout
3387
3388 \begin_layout Subsection*
3389 LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
3390 \end_layout
3391
3392 \begin_layout Description
3393 Action Add an optional parameter.
3394
3395 \end_layout
3396
3397 \begin_layout Description
3398 Notion Insert an optional parameter just behind the already existing optional
3399  parameters.
3400
3401 \end_layout
3402
3403 \begin_layout Description
3404 Syntax math-macro-add-optional-param
3405 \end_layout
3406
3407 \begin_layout Description
3408 Origin sts, 06 January 2008
3409 \end_layout
3410
3411 \begin_layout Subsection*
3412 LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
3413 \end_layout
3414
3415 \begin_layout Description
3416 Action Remove the last optional parameter.
3417
3418 \end_layout
3419
3420 \begin_layout Description
3421 Notion Remove the last optional parameter of a Math Macro and remove it
3422  in all the instances of the macro in the buffer.
3423
3424 \end_layout
3425
3426 \begin_layout Description
3427 Syntax math-macro-remove-optional-param
3428 \end_layout
3429
3430 \begin_layout Description
3431 Origin sts, 06 January 2008
3432 \end_layout
3433
3434 \begin_layout Subsection*
3435 LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
3436 \end_layout
3437
3438 \begin_layout Description
3439 Action Add a greedy optional parameter.
3440
3441 \end_layout
3442
3443 \begin_layout Description
3444 Notion Add a greedy optional parameter which eats the value from the following
3445  cells in mathed which are in the [value] format.
3446
3447 \end_layout
3448
3449 \begin_layout Description
3450 Syntax math-macro-add-greedy-optional-param
3451 \end_layout
3452
3453 \begin_layout Description
3454 Origin sts, 06 January 2008
3455 \end_layout
3456
3457 \begin_layout Subsection*
3458 LFUN_IN_MATHMACROTEMPLATE
3459 \end_layout
3460
3461 \begin_layout Description
3462 Action Only active in Math Macro definition.
3463
3464 \end_layout
3465
3466 \begin_layout Description
3467 Notion Dummy function which is only active in a Math Macro definition.
3468  It's used to toggle the Math Macro toolbar if the cursor moves into a Math
3469  Macro definition.
3470
3471 \end_layout
3472
3473 \begin_layout Description
3474 Syntax in-mathmacrotemplate
3475 \end_layout
3476
3477 \begin_layout Description
3478 Origin sts, 06 January 2008
3479 \end_layout
3480
3481 \begin_layout Subsection*
3482 LFUN_PARAGRAPH_MOVE_DOWN
3483 \end_layout
3484
3485 \begin_layout Description
3486 Action Moves the current paragraph downwards in the document.
3487
3488 \end_layout
3489
3490 \begin_layout Description
3491 Syntax paragraph-move-down
3492 \end_layout
3493
3494 \begin_layout Description
3495 Origin Edwin, 8 Apr 2006
3496 \end_layout
3497
3498 \begin_layout Subsection*
3499 LFUN_PARAGRAPH_MOVE_UP
3500 \end_layout
3501
3502 \begin_layout Description
3503 Action Moves the current paragraph upwards in the document.
3504
3505 \end_layout
3506
3507 \begin_layout Description
3508 Syntax paragraph-move-up
3509 \end_layout
3510
3511 \begin_layout Description
3512 Origin Edwin, 8 Apr 2006
3513 \end_layout
3514
3515 \begin_layout Subsection*
3516 LFUN_PARAGRAPH_UP
3517 \end_layout
3518
3519 \begin_layout Description
3520 Action Move the cursor to the next paragraph (or begining of the current
3521  one) in upward direction.
3522
3523 \end_layout
3524
3525 \begin_layout Description
3526 Syntax paragraph-up
3527 \end_layout
3528
3529 \begin_layout Description
3530 Origin Asger, 1 Oct 1996
3531 \end_layout
3532
3533 \begin_layout Subsection*
3534 LFUN_PARAGRAPH_UP_SELECT
3535 \end_layout
3536
3537 \begin_layout Description
3538 Action Move the cursor and select the text to the next paragraph (or begining
3539  of the current one) in upward direction.
3540
3541 \end_layout
3542
3543 \begin_layout Description
3544 Syntax paragraph-up-select
3545 \end_layout
3546
3547 \begin_layout Description
3548 Origin Asger, 1 Oct 1996
3549 \end_layout
3550
3551 \begin_layout Subsection*
3552 LFUN_PARAGRAPH_DOWN
3553 \end_layout
3554
3555 \begin_layout Description
3556 Action Move the cursor to the next paragraph (or begining of the current
3557  one) in downward direction.
3558
3559 \end_layout
3560
3561 \begin_layout Description
3562 Syntax paragraph-down
3563 \end_layout
3564
3565 \begin_layout Description
3566 Origin Asger, 1 Oct 1996
3567 \end_layout
3568
3569 \begin_layout Subsection*
3570 LFUN_PARAGRAPH_DOWN_SELECT
3571 \end_layout
3572
3573 \begin_layout Description
3574 Action Move the cursor and select the text to the next paragraph (or begining
3575  of the current one) in downward direction.
3576
3577 \end_layout
3578
3579 \begin_layout Description
3580 Syntax paragraph-down-select
3581 \end_layout
3582
3583 \begin_layout Description
3584 Origin Asger, 1 Oct 1996
3585 \end_layout
3586
3587 \begin_layout Subsection*
3588 LFUN_PARAGRAPH_GOTO
3589 \end_layout
3590
3591 \begin_layout Description
3592 Action Jump to a paragraph given by its id number and optionally the desired
3593  position within the paragraph.
3594
3595 \end_layout
3596
3597 \begin_layout Description
3598 Notion Note that id number of paragraph is not the sequential number of
3599  paragraph seen on the screen.
3600  Moreover the id is unique for all opened buffers (documents).
3601
3602 \end_layout
3603
3604 \begin_layout Description
3605 Syntax paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
3606 \end_layout
3607
3608 \begin_layout Description
3609 Params <PAR_ID_NUMBER>:  paragraph id
3610 \begin_inset Newline newline
3611 \end_inset
3612
3613  <POSITION_IN_PAR>: desired position within the paragraph
3614 \end_layout
3615
3616 \begin_layout Description
3617 Origin Dekel, 26 Aug 2000
3618 \end_layout
3619
3620 \begin_layout Subsection*
3621 LFUN_BREAK_PARAGRAPH
3622 \end_layout
3623
3624 \begin_layout Description
3625 Action Breaks the current paragraph at the current location.
3626
3627 \end_layout
3628
3629 \begin_layout Description
3630 Syntax break-paragraph
3631 \end_layout
3632
3633 \begin_layout Subsection*
3634 LFUN_BREAK_PARAGRAPH
3635 \end_layout
3636
3637 \begin_layout Description
3638 Action Breaks the current paragraph at the current location.
3639
3640 \end_layout
3641
3642 \begin_layout Description
3643 Notion Removes the selection.
3644
3645 \end_layout
3646
3647 \begin_layout Description
3648 Syntax break-paragraph [<LAYOUT>]
3649 \end_layout
3650
3651 \begin_layout Description
3652 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to
3653  default layout) when the cursor is at the end of the line.
3654
3655 \end_layout
3656
3657 \begin_layout Subsection*
3658 LFUN_PARAGRAPH_PARAMS
3659 \end_layout
3660
3661 \begin_layout Description
3662 Action Change paragraph settings.
3663
3664 \end_layout
3665
3666 \begin_layout Description
3667 Notion Modifies the current paragraph, or currently selected paragraphs.
3668  This function only modifies, and does not override, existing settings.
3669  Note that the "leftindent" indent setting is deprecated.
3670
3671 \end_layout
3672
3673 \begin_layout Description
3674 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
3675 \end_layout
3676
3677 \begin_layout Description
3678 Params <INDENT>:
3679 \backslash
3680 noindent|
3681 \backslash
3682 indent|
3683 \backslash
3684 indent-toggle|
3685 \backslash
3686 leftindent LENGTH
3687 \begin_inset Newline newline
3688 \end_inset
3689
3690  <SPACING>:
3691 \backslash
3692 paragraph_spacing default|single|onehalf|double|other
3693 \begin_inset Newline newline
3694 \end_inset
3695
3696  <ALIGN>:
3697 \backslash
3698 align block|left|right|center|default
3699 \begin_inset Newline newline
3700 \end_inset
3701
3702  <OTHERS>:
3703 \backslash
3704 labelwidthstring WIDTH|
3705 \backslash
3706 start_of_appendix
3707 \begin_inset Newline newline
3708 \end_inset
3709
3710
3711 \end_layout
3712
3713 \begin_layout Description
3714 Origin rgh, Aug 15 2007
3715 \end_layout
3716
3717 \begin_layout Subsection*
3718 LFUN_PARAGRAPH_PARAMS_APPLY
3719 \end_layout
3720
3721 \begin_layout Description
3722 Action Change paragraph settings.
3723
3724 \end_layout
3725
3726 \begin_layout Description
3727 Notion Overwrite all nonspecified settings to the default ones.
3728  Use paragraph-params lfun if you don't want to overwrite others settings.
3729
3730 \end_layout
3731
3732 \begin_layout Description
3733 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
3734 \end_layout
3735
3736 \begin_layout Description
3737 Params For parameters see LFUN_PARAGRAPH_PARAMS
3738 \end_layout
3739
3740 \begin_layout Description
3741 Origin leeming, 30 Mar 2004
3742 \end_layout
3743
3744 \begin_layout Subsection*
3745 LFUN_PARAGRAPH_UPDATE
3746 \end_layout
3747
3748 \begin_layout Description
3749 Action Updates the values inside the paragraph dialog from the paragraph.
3750
3751 \end_layout
3752
3753 \begin_layout Description
3754 Notion This is internal LFUN, not to be used by users.
3755  Called internally by LFUN_DIALOG_UPDATE.
3756
3757 \end_layout
3758
3759 \begin_layout Description
3760 Origin leeming, 13 Mar 2003
3761 \end_layout
3762
3763 \begin_layout Subsection*
3764 LFUN_OUTLINE_UP
3765 \end_layout
3766
3767 \begin_layout Description
3768 Action Move the current group in the upward direction in the structure of
3769  the document.
3770
3771 \end_layout
3772
3773 \begin_layout Description
3774 Notion The "group" can be Part/Chapter/Section/etc.
3775  It moves the whole substructure of the group.
3776
3777 \end_layout
3778
3779 \begin_layout Description
3780 Syntax outline-up
3781 \end_layout
3782
3783 \begin_layout Description
3784 Origin Vermeer, 23 Mar 2006
3785 \end_layout
3786
3787 \begin_layout Subsection*
3788 LFUN_OUTLINE_DOWN
3789 \end_layout
3790
3791 \begin_layout Description
3792 Action Move the current group in the downward direction in the structure
3793  of the document.
3794
3795 \end_layout
3796
3797 \begin_layout Description
3798 Notion The "group" can be Part/Chapter/Section/etc.
3799  It moves the whole substructure of the group.
3800
3801 \end_layout
3802
3803 \begin_layout Description
3804 Syntax outline-down
3805 \end_layout
3806
3807 \begin_layout Description
3808 Origin Vermeer, 23 Mar 2006
3809 \end_layout
3810
3811 \begin_layout Subsection*
3812 LFUN_OUTLINE_IN
3813 \end_layout
3814
3815 \begin_layout Description
3816 Action Moves the current group in the downward direction in the hierarchy
3817  of the document structure.
3818
3819 \end_layout
3820
3821 \begin_layout Description
3822 Notion Part -> Chapter -> Section -> etc.
3823
3824 \end_layout
3825
3826 \begin_layout Description
3827 Syntax outline-in
3828 \end_layout
3829
3830 \begin_layout Description
3831 Origin Vermeer, 23 Mar 2006
3832 \end_layout
3833
3834 \begin_layout Subsection*
3835 LFUN_OUTLINE_OUT
3836 \end_layout
3837
3838 \begin_layout Description
3839 Action Moves the current group in the upward direction in the hierarchy
3840  of the document structure.
3841
3842 \end_layout
3843
3844 \begin_layout Description
3845 Notion Part <- Chapter <- Section <- etc.
3846
3847 \end_layout
3848
3849 \begin_layout Description
3850 Syntax outline-out
3851 \end_layout
3852
3853 \begin_layout Description
3854 Origin Vermeer, 23 Mar 2006
3855 \end_layout
3856
3857 \begin_layout Subsection*
3858 LFUN_INSET_EDIT
3859 \end_layout
3860
3861 \begin_layout Description
3862 Action Edit the inset at cursor with an external application, *
3863      if one is attributed.
3864
3865 \end_layout
3866
3867 \begin_layout Description
3868 Syntax inset-edit [<INSET_PARAMS>]
3869 \end_layout
3870
3871 \begin_layout Description
3872 Params <INSET_PARAMS>: Parameters for the inset.
3873
3874 \begin_inset Newline newline
3875 \end_inset
3876
3877  Currently only the filename will be considered.
3878
3879 \end_layout
3880
3881 \begin_layout Description
3882 Origin JSpitzm, 27 Apr 2006
3883 \end_layout
3884
3885 \begin_layout Subsection*
3886 LFUN_TABULAR_INSERT
3887 \end_layout
3888
3889 \begin_layout Description
3890 Action Inserts table into the document.
3891
3892 \end_layout
3893
3894 \begin_layout Description
3895 Syntax tabular-insert [<ROWS> <COLUMNS>]
3896 \end_layout
3897
3898 \begin_layout Description
3899 Params In case no arguments are given show insert dialog.
3900
3901 \end_layout
3902
3903 \begin_layout Description
3904 Origin Jug, 12 Apr 2000
3905 \end_layout
3906
3907 \begin_layout Subsection*
3908 LFUN_TABULAR_FEATURE
3909 \end_layout
3910
3911 \begin_layout Description
3912 Action Sets various features to the table/cell on the current cursor position.
3913
3914 \end_layout
3915
3916 \begin_layout Description
3917 Notion Various math-environment features are handled here as well, e.g.
3918  add-vline-left/right for Grid/Cases environment
3919 \end_layout
3920
3921 \begin_layout Description
3922 Syntax tabular-feature <FEATURE> [<ARG>]
3923 \end_layout
3924
3925 \begin_layout Description
3926 Params <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|cop
3927 y-column| toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
3928  align-left|align-right|align-center|align-block|valign-top|valign-bottom|
3929  valign-middle|m-align-left|m-align-right|m-align-center|m-valign-top| m-valign-
3930 bottom|m-valign-middle|multicolumn|set-all-lines|unset-all-lines| set-longtabula
3931 r|unset-longtabular|set-pwidth|set-mpwidth| set-rotate-tabular|unset-rotate-tabu
3932 lar|toggle-rotate-tabular| set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|
3933 set-usebox|set-lthead| unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot
3934 |unset-ltfoot| set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
3935  set-special-column|set-special-multi|set-booktabs|unset-booktabs| set-top-space
3936 |set-bottom-space|set-interline-space|set-border-lines| tabular-valign-top|tabul
3937 ar-valign-middle|tabular-valign-bottom
3938 \begin_inset Newline newline
3939 \end_inset
3940
3941  <ARG>: additional argument for some commands, use debug mode to explore
3942  its values.
3943
3944 \end_layout
3945
3946 \begin_layout Description
3947 Origin Jug, 28 Jul 2000
3948 \end_layout
3949
3950 \begin_layout Subsection*
3951 LFUN_CELL_BACKWARD
3952 \end_layout
3953
3954 \begin_layout Description
3955 Action Moves the cursor to the previous cell inside the table.
3956
3957 \end_layout
3958
3959 \begin_layout Description
3960 Syntax cell-backward
3961 \end_layout
3962
3963 \begin_layout Description
3964 Origin Jug, 22 May 2000
3965 \end_layout
3966
3967 \begin_layout Subsection*
3968 LFUN_CELL_FORWARD
3969 \end_layout
3970
3971 \begin_layout Description
3972 Action Moves the cursor to the next cell inside the table.
3973
3974 \end_layout
3975
3976 \begin_layout Description
3977 Syntax cell-forward
3978 \end_layout
3979
3980 \begin_layout Subsection*
3981 LFUN_CELL_SPLIT
3982 \end_layout
3983
3984 \begin_layout Description
3985 Action Splits cell and shifts right part to the next cell (inside the math
3986  grid).
3987
3988 \end_layout
3989
3990 \begin_layout Description
3991 Syntax cell-split
3992 \end_layout
3993
3994 \begin_layout Description
3995 Origin Ale, 15 May 1997
3996 \end_layout
3997
3998 \begin_layout Subsection*
3999 LFUN_VC_REGISTER
4000 \end_layout
4001
4002 \begin_layout Description
4003 Action Register the document as an file inside version control system (RCS,
4004  CVS).
4005
4006 \end_layout
4007
4008 \begin_layout Description
4009 Notion File is registered inside cvs, svn or rcs repository acording to
4010  the existence of cvs/svn/rcs entries in the document's directory.
4011
4012 \begin_inset Newline newline
4013 \end_inset
4014
4015  See LyX Additional Features Manual (Version Control Chapter) for additional
4016  information.
4017
4018 \end_layout
4019
4020 \begin_layout Description
4021 Syntax vc-register
4022 \end_layout
4023
4024 \begin_layout Description
4025 Origin Lgb, 1 Jul 1997
4026 \end_layout
4027
4028 \begin_layout Subsection*
4029 LFUN_VC_CHECK_IN
4030 \end_layout
4031
4032 \begin_layout Description
4033 Action Checks-in/commits the changes of the registered file to the repository.
4034
4035 \end_layout
4036
4037 \begin_layout Description
4038 Notion In RCS case this also unlocks the file.
4039
4040 \end_layout
4041
4042 \begin_layout Description
4043 Syntax vc-check-in
4044 \end_layout
4045
4046 \begin_layout Description
4047 Origin Lgb, 1 Jul 1997
4048 \end_layout
4049
4050 \begin_layout Subsection*
4051 LFUN_VC_CHECK_OUT
4052 \end_layout
4053
4054 \begin_layout Description
4055 Action Checks-out the document for edit (and locks it for RCS).
4056
4057 \end_layout
4058
4059 \begin_layout Description
4060 Notion This is implemented only for RCS and SVN, not CVS.
4061
4062 \end_layout
4063
4064 \begin_layout Description
4065 Syntax vc-check-out
4066 \end_layout
4067
4068 \begin_layout Description
4069 Origin Lgb, 1 Jul 1997
4070 \end_layout
4071
4072 \begin_layout Subsection*
4073 LFUN_VC_REVERT
4074 \end_layout
4075
4076 \begin_layout Description
4077 Action Reverts the document to the last check-in/commit in VCS.
4078
4079 \end_layout
4080
4081 \begin_layout Description
4082 Syntax vc-revert
4083 \end_layout
4084
4085 \begin_layout Description
4086 Origin Lgb, 1 Jul 1997
4087 \end_layout
4088
4089 \begin_layout Subsection*
4090 LFUN_VC_UNDO_LAST
4091 \end_layout
4092
4093 \begin_layout Description
4094 Action Undo last check-in.
4095
4096 \end_layout
4097
4098 \begin_layout Description
4099 Notion This is currently implemented only for RCS.
4100
4101 \end_layout
4102
4103 \begin_layout Description
4104 Syntax vc-check-out
4105 \end_layout
4106
4107 \begin_layout Description
4108 Origin Lgb, 1 Jul 1997
4109 \end_layout
4110
4111 \begin_layout Subsection*
4112 LFUN_VC_COMMAND
4113 \end_layout
4114
4115 \begin_layout Description
4116 Action Executes external command.
4117  This command is intended to support additional VCS commands.
4118
4119 \end_layout
4120
4121 \begin_layout Description
4122 Syntax vc-command <FLAG> <PATH> <COMMAND>
4123 \end_layout
4124
4125 \begin_layout Description
4126 Params  <FLAG>: Flags for the command can be combined together.
4127
4128 \begin_inset Newline newline
4129 \end_inset
4130
4131  U - dUmmy - no flags
4132 \begin_inset Newline newline
4133 \end_inset
4134
4135  D - Doc - need document loaded to proceed
4136 \begin_inset Newline newline
4137 \end_inset
4138
4139  I - dIrty - mark document dirty
4140 \begin_inset Newline newline
4141 \end_inset
4142
4143  R - Reload - ensure that the document is saved and reload it after command
4144  execution
4145 \begin_inset Newline newline
4146 \end_inset
4147
4148  M - Message - ask for input string (commit message)
4149 \begin_inset Newline newline
4150 \end_inset
4151
4152  <PATH>: path where to start.
4153  $$p will be replaced by the current document path.
4154
4155 \begin_inset Newline newline
4156 \end_inset
4157
4158  <COMMAND>: command to execute.
4159  $$i/$$p/$$m will be replaced by the current document/path/message.
4160
4161 \end_layout
4162
4163 \begin_layout Description
4164 Sample vc-command DR $$p "svn up"
4165 \end_layout
4166
4167 \begin_layout Description
4168 Origin sanda, 13 Jan 2009
4169 \end_layout
4170
4171 \begin_layout Subsection*
4172 LFUN_CHANGES_TRACK
4173 \end_layout
4174
4175 \begin_layout Description
4176 Action Toggles change tracking to on/off.
4177
4178 \end_layout
4179
4180 \begin_layout Description
4181 Syntax changes-track
4182 \end_layout
4183
4184 \begin_layout Description
4185 Origin levon, 1 Oct 2002
4186 \end_layout
4187
4188 \begin_layout Subsection*
4189 LFUN_CHANGES_OUTPUT
4190 \end_layout
4191
4192 \begin_layout Description
4193 Action Toggles showing of change tracking in typesetted output.
4194
4195 \end_layout
4196
4197 \begin_layout Description
4198 Syntax changes-output
4199 \end_layout
4200
4201 \begin_layout Description
4202 Origin jspitzm, 21 Jan 2005
4203 \end_layout
4204
4205 \begin_layout Subsection*
4206 LFUN_CHANGE_NEXT
4207 \end_layout
4208
4209 \begin_layout Description
4210 Action Moves the cursor to the position of the next change of the change
4211  tracking records.
4212
4213 \end_layout
4214
4215 \begin_layout Description
4216 Syntax change-next
4217 \end_layout
4218
4219 \begin_layout Description
4220 Origin schmitt, 4 Oct 2006
4221 \end_layout
4222
4223 \begin_layout Subsection*
4224 LFUN_CHANGES_MERGE
4225 \end_layout
4226
4227 \begin_layout Description
4228 Action Open change tracking dialog for merging and moves the cursor to the
4229  position of the next change.
4230
4231 \end_layout
4232
4233 \begin_layout Description
4234 Syntax changes-merge
4235 \end_layout
4236
4237 \begin_layout Description
4238 Origin Levon, 16 Oct 2002
4239 \end_layout
4240
4241 \begin_layout Subsection*
4242 LFUN_CHANGE_ACCEPT
4243 \end_layout
4244
4245 \begin_layout Description
4246 Action Accepts tracked change inside the selection.
4247
4248 \end_layout
4249
4250 \begin_layout Description
4251 Syntax change-accept
4252 \end_layout
4253
4254 \begin_layout Description
4255 Origin Levon, 16 Oct 2002
4256 \end_layout
4257
4258 \begin_layout Subsection*
4259 LFUN_CHANGE_REJECT
4260 \end_layout
4261
4262 \begin_layout Description
4263 Action Rejects tracked change inside the selection.
4264
4265 \end_layout
4266
4267 \begin_layout Description
4268 Syntax change-accept
4269 \end_layout
4270
4271 \begin_layout Description
4272 Origin Levon, 16 Oct 2002
4273 \end_layout
4274
4275 \begin_layout Subsection*
4276 LFUN_ALL_CHANGES_ACCEPT
4277 \end_layout
4278
4279 \begin_layout Description
4280 Action Accepts all tracked changes in the document.
4281
4282 \end_layout
4283
4284 \begin_layout Description
4285 Syntax all-changes-accept
4286 \end_layout
4287
4288 \begin_layout Description
4289 Origin Levon, 16 Oct 2002
4290 \end_layout
4291
4292 \begin_layout Subsection*
4293 LFUN_ALL_CHANGES_REJECT
4294 \end_layout
4295
4296 \begin_layout Description
4297 Action Rejects all tracked changes in the document.
4298
4299 \end_layout
4300
4301 \begin_layout Description
4302 Notion Reject does not work recursively; the user may have to repeat the
4303  operation.
4304
4305 \end_layout
4306
4307 \begin_layout Description
4308 Syntax all-changes-reject
4309 \end_layout
4310
4311 \begin_layout Description
4312 Origin Levon, 16 Oct 2002
4313 \end_layout
4314
4315 \begin_layout Subsection*
4316 LFUN_INSET_APPLY
4317 \end_layout
4318
4319 \begin_layout Description
4320 Action Apply data for an inset.
4321
4322 \end_layout
4323
4324 \begin_layout Description
4325 Notion LFUN_INSET_APPLY is sent from the dialogs when the data should be
4326  applied.
4327  This is either changed to LFUN_INSET_MODIFY or LFUN_INSET_INSERT depending
4328  on the context where it is called.
4329
4330 \end_layout
4331
4332 \begin_layout Description
4333 Syntax inset-apply <ARGS>
4334 \end_layout
4335
4336 \begin_layout Description
4337 Params See LFUN_INSET_INSERT .
4338
4339 \end_layout
4340
4341 \begin_layout Subsection*
4342 LFUN_INSET_DISSOLVE
4343 \end_layout
4344
4345 \begin_layout Description
4346 Action Dissolve the current inset into text.
4347
4348 \end_layout
4349
4350 \begin_layout Description
4351 Syntax inset-dissolve [<INSET>]
4352 \end_layout
4353
4354 \begin_layout Description
4355 Params <INSET>: this can be used to make sure the right kind of inset is
4356  dissolved.
4357  For example "dissolve" entry in the charstyles sub-menu should only dissolve
4358  the charstyle inset, even if the cursor is inside several nested insets
4359  of different type.
4360
4361 \begin_inset Newline newline
4362 \end_inset
4363
4364  For values see lyx::InsetLayout::lyxtype_ .
4365
4366 \end_layout
4367
4368 \begin_layout Description
4369 Origin JSpitz, 7 Aug 2006
4370 \end_layout
4371
4372 \begin_layout Subsection*
4373 LFUN_INSET_INSERT
4374 \end_layout
4375
4376 \begin_layout Description
4377 Action Insert new inset (type given by the parameters).
4378
4379 \end_layout
4380
4381 \begin_layout Description
4382 Syntax inset-insert <INSET> <ARGS>
4383 \end_layout
4384
4385 \begin_layout Description
4386 Params <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics| hyperlink|i
4387 nclude|index|label|nomencl|vspace|ref|toc>
4388 \begin_inset Newline newline
4389 \end_inset
4390
4391  <ARGS>: depends on the given inset.
4392  Use "lyx -dbg action" to explore.
4393
4394 \end_layout
4395
4396 \begin_layout Description
4397 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
4398 \backslash
4399 end_inset
4400 \begin_inset Newline newline
4401 \end_inset
4402
4403 where <label name> is the name of the referenced label and<Format> is one
4404  of the following:
4405 \begin_inset Newline newline
4406 \end_inset
4407
4408 ref -- <reference>
4409 \begin_inset Newline newline
4410 \end_inset
4411
4412 eqref -- (<reference>)
4413 \begin_inset Newline newline
4414 \end_inset
4415
4416 pageref -- <page>
4417 \begin_inset Newline newline
4418 \end_inset
4419
4420 vpageref -- on <page>
4421 \begin_inset Newline newline
4422 \end_inset
4423
4424 vref -- <reference> on <page>
4425 \begin_inset Newline newline
4426 \end_inset
4427
4428 prettyref -- Formatted reference
4429 \end_layout
4430
4431 \begin_layout Subsection*
4432 LFUN_INSET_MODIFY
4433 \end_layout
4434
4435 \begin_layout Description
4436 Action Modify existing inset.
4437
4438 \end_layout
4439
4440 \begin_layout Description
4441 Notion Used for label, floats, listings, box, branch, external, wrap bibtex,
4442  ert, command, graphics, note, space, vspace, tabular, bibitem, inlude,
4443  ref insets.
4444
4445 \end_layout
4446
4447 \begin_layout Description
4448 Syntax inset-modify <INSET> <ARGS>
4449 \end_layout
4450
4451 \begin_layout Description
4452 Params See LFUN_INSET_INSERT for further details.
4453
4454 \end_layout
4455
4456 \begin_layout Subsection*
4457 LFUN_NEXT_INSET_MODIFY
4458 \end_layout
4459
4460 \begin_layout Description
4461 Action Modify the inset at cursor position, if there is one.
4462
4463 \end_layout
4464
4465 \begin_layout Description
4466 Notion Used for label, floats, listings, box, branch, external, wrap bibtex,
4467  ert, command, graphics, note, space, vspace, tabular, bibitem, inlude,
4468  ref insets.
4469
4470 \end_layout
4471
4472 \begin_layout Description
4473 Syntax next-inset-modify <INSET> <ARGS>
4474 \end_layout
4475
4476 \begin_layout Description
4477 Syntax next-inset-modify changetype <TYPE>
4478 \end_layout
4479
4480 \begin_layout Description
4481 Params See LFUN_INSET_INSERT for further details.
4482
4483 \end_layout
4484
4485 \begin_layout Description
4486 Origin JSpitzm, 23 Mar 2008
4487 \end_layout
4488
4489 \begin_layout Subsection*
4490 LFUN_INSET_DIALOG_UPDATE
4491 \end_layout
4492
4493 \begin_layout Description
4494 Action Updates the values inside the dialog from the inset.
4495
4496 \end_layout
4497
4498 \begin_layout Description
4499 Notion This is internal LFUN, not to be used by users.
4500  Called internally by LFUN_DIALOG_UPDATE
4501 \end_layout
4502
4503 \begin_layout Description
4504 Params <DIALOG-NAME>
4505 \end_layout
4506
4507 \begin_layout Description
4508 Origin leeming, 25 Feb 2003
4509 \end_layout
4510
4511 \begin_layout Subsection*
4512 LFUN_INSET_SETTINGS
4513 \end_layout
4514
4515 \begin_layout Description
4516 Action Open the inset's properties dialog.
4517
4518 \end_layout
4519
4520 \begin_layout Description
4521 Notion Used for box, branch, ert, float, listings, note, tabular, wrap insets.
4522
4523 \end_layout
4524
4525 \begin_layout Description
4526 Syntax inset-settings <INSET>
4527 \end_layout
4528
4529 \begin_layout Description
4530 Params <INSET>: <box|branch|ert|float|listings|note|tabular|wrap>
4531 \end_layout
4532
4533 \begin_layout Subsection*
4534 LFUN_NEXT_INSET_TOGGLE
4535 \end_layout
4536
4537 \begin_layout Description
4538 Action Toggles the inset at cursor position.
4539  For collapsables, this means it will be (un-)collapsed, in case of other
4540  insets, the editing widget (dialog) will be entered.
4541  Also cf.
4542  LFUN_INSET_SETTINGS.
4543
4544 \end_layout
4545
4546 \begin_layout Description
4547 Notion Used for label, floats, listings, box, branch, external, wrap bibtex,
4548  ert, command, graphics, note, space, vspace, tabular, bibitem, inlude,
4549  ref insets.
4550
4551 \end_layout
4552
4553 \begin_layout Description
4554 Syntax next-inset-toggle <ARG>
4555 \end_layout
4556
4557 \begin_layout Description
4558 Params <ARG>: these are passed as arguments to LFUN_INSET_TOGGLE .
4559
4560 \end_layout
4561
4562 \begin_layout Description
4563 Origin leeming, 30 Mar 2004
4564 \end_layout
4565
4566 \begin_layout Subsection*
4567 LFUN_INSET_TOGGLE
4568 \end_layout
4569
4570 \begin_layout Description
4571 Action Toggles the collapsable inset we are currently in.
4572
4573 \end_layout
4574
4575 \begin_layout Description
4576 Syntax inset-toggle [<ARG>]
4577 \end_layout
4578
4579 \begin_layout Description
4580 Params <ARG>: <open|close|toggle|assign>.
4581
4582 \begin_inset Newline newline
4583 \end_inset
4584
4585  open/close/toggle are for collapsable insets.
4586  close can be currently used by LFUN_NEXT_INSET_TOGGLE.
4587  toggle is used when no argument is given.
4588
4589 \begin_inset Newline newline
4590 \end_inset
4591
4592  assign is for branch inset.
4593
4594 \end_layout
4595
4596 \begin_layout Description
4597 Origin lasgouttes, 19 Jul 2001
4598 \end_layout
4599
4600 \begin_layout Subsection*
4601 LFUN_ALL_INSETS_TOGGLE
4602 \end_layout
4603
4604 \begin_layout Description
4605 Action Toggles (open/closes) all collapsable insets (of a given type) in
4606  the document.
4607
4608 \end_layout
4609
4610 \begin_layout Description
4611 Notion Used for box, branch, ert, float, listings, note, tabular, wrap insets.
4612
4613 \end_layout
4614
4615 \begin_layout Description
4616 Syntax all-insets-toggle <STATE> <INSET>
4617 \end_layout
4618
4619 \begin_layout Description
4620 Params <STATE>: <toggle|open|close> default: toggle
4621 \begin_inset Newline newline
4622 \end_inset
4623
4624  <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all
4625  insets
4626 \end_layout
4627
4628 \begin_layout Description
4629 Origin leeming, 30 Mar 2004
4630 \end_layout
4631
4632 \begin_layout Subsection*
4633 LFUN_SET_GRAPHICS_GROUP
4634 \end_layout
4635
4636 \begin_layout Description
4637 Action Set the group for the graphics inset on the cursor position.
4638
4639 \end_layout
4640
4641 \begin_layout Description
4642 Syntax set-graphics-group [<GROUP>]
4643 \end_layout
4644
4645 \begin_layout Description
4646 Params <GROUP>: Id for an existing group.
4647  In case the Id is an empty string, the graphics inset is removed from the
4648  current group.
4649
4650 \end_layout
4651
4652 \begin_layout Description
4653 Origin sanda, 6 May 2008
4654 \end_layout
4655
4656 \begin_layout Subsection*
4657 LFUN_FINISHED_FORWARD
4658 \end_layout
4659
4660 \begin_layout Description
4661 Action Moves the cursor out of the current slice, going forward.
4662
4663 \end_layout
4664
4665 \begin_layout Description
4666 Notion Cursor movement within an inset may be different than cursor movement
4667  in the surrounding text.
4668  This action should be called automatically by the cursor movement within
4669  the inset, when movement within the inset has ceased (reached the end of
4670  the last paragraph, for example), in order to move correctly back into
4671  the surrounding text.
4672
4673 \end_layout
4674
4675 \begin_layout Subsection*
4676 LFUN_FINISHED_BACKWARD
4677 \end_layout
4678
4679 \begin_layout Description
4680 Action Moves the cursor out of the current slice, going backwards.
4681
4682 \end_layout
4683
4684 \begin_layout Description
4685 Notion See also LFUN_FINISHED_FORWARD.
4686
4687 \end_layout
4688
4689 \begin_layout Subsection*
4690 LFUN_FINISHED_RIGHT
4691 \end_layout
4692
4693 \begin_layout Description
4694 Action Moves the cursor out of the current slice, going right.
4695
4696 \end_layout
4697
4698 \begin_layout Description
4699 Notion See also LFUN_FINISHED_FORWARD
4700 \end_layout
4701
4702 \begin_layout Subsection*
4703 LFUN_FINISHED_LEFT
4704 \end_layout
4705
4706 \begin_layout Description
4707 Action Moves the cursor out of the current slice, going left.
4708
4709 \end_layout
4710
4711 \begin_layout Description
4712 Notion See also LFUN_FINISHED_FORWARD.
4713
4714 \end_layout
4715
4716 \begin_layout Subsection*
4717 LFUN_LANGUAGE
4718 \end_layout
4719
4720 \begin_layout Description
4721 Action Set language from the current cursor position.
4722
4723 \end_layout
4724
4725 \begin_layout Description
4726 Syntax language <LANG>
4727 \end_layout
4728
4729 \begin_layout Description
4730 Params <LANG>: Requested language.
4731  Look in lib/languages for the list.
4732
4733 \end_layout
4734
4735 \begin_layout Description
4736 Origin Dekel, 2 Mar 2000
4737 \end_layout
4738
4739 \begin_layout Subsection*
4740 LFUN_LABEL_GOTO
4741 \end_layout
4742
4743 \begin_layout Description
4744 Action Goto a label.
4745
4746 \end_layout
4747
4748 \begin_layout Description
4749 Syntax label-goto [<LABEL>]
4750 \end_layout
4751
4752 \begin_layout Description
4753 Params <LABEL>: Requested label.
4754  If no label is given and refernce is on cursor position, Bookmark 0 is
4755  saved and cursor moves to the position of referenced label.
4756
4757 \end_layout
4758
4759 \begin_layout Description
4760 Origin Ale, 6 Aug 1997
4761 \end_layout
4762
4763 \begin_layout Subsection*
4764 LFUN_LABEL_INSERT
4765 \end_layout
4766
4767 \begin_layout Description
4768 Action Inserts label to text or displayed formula.
4769
4770 \end_layout
4771
4772 \begin_layout Description
4773 Syntax label-insert [<LABEL>]
4774 \end_layout
4775
4776 \begin_layout Description
4777 Params <LABEL>: Requested label.
4778  If no label is given dialog requesting name will be opened.
4779
4780 \end_layout
4781
4782 \begin_layout Subsection*
4783 LFUN_REFERENCE_NEXT
4784 \end_layout
4785
4786 \begin_layout Description
4787 Action Go to the next label or cross-reference.
4788
4789 \end_layout
4790
4791 \begin_layout Description
4792 Syntax reference-next
4793 \end_layout
4794
4795 \begin_layout Description
4796 Origin Dekel, 14 Jan 2001
4797 \end_layout
4798
4799 \begin_layout Subsection*
4800 LFUN_BOOKMARK_GOTO
4801 \end_layout
4802
4803 \begin_layout Description
4804 Action Goto a bookmark.
4805
4806 \end_layout
4807
4808 \begin_layout Description
4809 Notion Moves the cursor to the numbered bookmark, opening the file if necessary.
4810  Note that bookmarsk are saved per-session, not per file.
4811
4812 \end_layout
4813
4814 \begin_layout Description
4815 Syntax bookmark-goto <NUMBER>
4816 \end_layout
4817
4818 \begin_layout Description
4819 Params <NUMBER>: the number of the bookmark to restore.
4820
4821 \end_layout
4822
4823 \begin_layout Description
4824 Origin Dekel, 27 January 2001
4825 \end_layout
4826
4827 \begin_layout Subsection*
4828 LFUN_BOOKMARK_SAVE
4829 \end_layout
4830
4831 \begin_layout Description
4832 Action Save a bookmark.
4833
4834 \end_layout
4835
4836 \begin_layout Description
4837 Notion Saves a numbered bookmark to the sessions file.
4838  The number must be between 1 and 9, inclusive.
4839  Note that bookmarks are saved per-session, not per file.
4840
4841 \end_layout
4842
4843 \begin_layout Description
4844 Syntax bookmark-save <NUMBER>
4845 \end_layout
4846
4847 \begin_layout Description
4848 Params <NUMBER>: the number of the bookmark to save.
4849
4850 \end_layout
4851
4852 \begin_layout Description
4853 Origin Dekel, 27 January 2001
4854 \end_layout
4855
4856 \begin_layout Subsection*
4857 LFUN_BOOKMARK_CLEAR
4858 \end_layout
4859
4860 \begin_layout Description
4861 Action Clears the list of saved bookmarks.
4862
4863 \end_layout
4864
4865 \begin_layout Description
4866 Syntax bookmark-clear
4867 \end_layout
4868
4869 \begin_layout Description
4870 Origin bpeng, 31 October 2006
4871 \end_layout
4872
4873 \begin_layout Subsection*
4874 LFUN_HELP_OPEN
4875 \end_layout
4876
4877 \begin_layout Description
4878 Action Open the given help file according to the language setting.
4879
4880 \end_layout
4881
4882 \begin_layout Description
4883 Syntax help-open <FILE>[.lyx]
4884 \end_layout
4885
4886 \begin_layout Description
4887 Params <FILE>: any document from (/usr/share/)doc directory.
4888
4889 \end_layout
4890
4891 \begin_layout Description
4892 Origin Jug, 27 Jun 1999
4893 \end_layout
4894
4895 \begin_layout Subsection*
4896 LFUN_LYX_QUIT
4897 \end_layout
4898
4899 \begin_layout Description
4900 Action Terminates the current LyX instance.
4901
4902 \end_layout
4903
4904 \begin_layout Description
4905 Notion Terminates the current LyX instance, asking whether to save modified
4906  documents, etc.
4907
4908 \end_layout
4909
4910 \begin_layout Description
4911 Syntax lyx-quit
4912 \end_layout
4913
4914 \begin_layout Subsection*
4915 LFUN_TOOLBAR_TOGGLE
4916 \end_layout
4917
4918 \begin_layout Description
4919 Action Toggles visibility of a given toolbar between on/off/auto.
4920
4921 \end_layout
4922
4923 \begin_layout Description
4924 Notion Skiping "auto" when allowauto is false.
4925
4926 \end_layout
4927
4928 \begin_layout Description
4929 Syntax toolbar-toggle <NAME> [allowauto]
4930 \end_layout
4931
4932 \begin_layout Description
4933 Params <NAME>: standard|extra|table|math|mathmacrotemplate| minibuffer|review|vi
4934 ew/update|math_panels|vcs
4935 \end_layout
4936
4937 \begin_layout Description
4938 Origin Edwin, 21 May 2007
4939 \end_layout
4940
4941 \begin_layout Subsection*
4942 LFUN_MENU_OPEN
4943 \end_layout
4944
4945 \begin_layout Description
4946 Action Opens the menu given by its name.
4947
4948 \end_layout
4949
4950 \begin_layout Description
4951 Syntax menu-open <NAME>
4952 \end_layout
4953
4954 \begin_layout Description
4955 Params <NAME>: menu name.
4956  See various .inc files in lib/ui for candidates.
4957
4958 \end_layout
4959
4960 \begin_layout Subsection*
4961 LFUN_UI_TOGGLE
4962 \end_layout
4963
4964 \begin_layout Description
4965 Action Various UI visibility-toggling actions.
4966
4967 \end_layout
4968
4969 \begin_layout Description
4970 Syntax ui-toggle <statusbar|menubar|frame|fullscreen>
4971 \end_layout
4972
4973 \begin_layout Description
4974 Params statusbar  : Toggle visibility of the statusbar.
4975
4976 \begin_inset Newline newline
4977 \end_inset
4978
4979  menubar    : Toggle visibility of the menubar.
4980
4981 \begin_inset Newline newline
4982 \end_inset
4983
4984  scrollbar  : Toggle visibility of the scrollbar.
4985
4986 \begin_inset Newline newline
4987 \end_inset
4988
4989  frame      : Toggle visibility of the frames around editing window.
4990
4991 \begin_inset Newline newline
4992 \end_inset
4993
4994  fullscreen : Toggle fullscreen mode.
4995  This also covers calling the previous functions.
4996  However LFUN_TOOLBAR_TOGGLE for the custom tweaks of the toolbars should
4997  be used.
4998
4999 \end_layout
5000
5001 \begin_layout Description
5002 Origin sanda, 9 Feb 2007
5003 \end_layout
5004
5005 \begin_layout Subsection*
5006 WINDOW_NEW
5007 \end_layout
5008
5009 \begin_layout Description
5010 Action Creates new empty LyX window.
5011
5012 \end_layout
5013
5014 \begin_layout Description
5015 Notion Already opened documents from the previous window can be found under
5016  View menu.
5017
5018 \end_layout
5019
5020 \begin_layout Description
5021 Syntax window-new [<GEOMETRY>]
5022 \end_layout
5023
5024 \begin_layout Description
5025 Params <GEOMETRY>: pass the geometry of the window.
5026  This parameter is currently accepted only on Windows platform.
5027
5028 \end_layout
5029
5030 \begin_layout Description
5031 Origin Abdel, 21 Oct 2006
5032 \end_layout
5033
5034 \begin_layout Subsection*
5035 LFUN_WINDOW_CLOSE
5036 \end_layout
5037
5038 \begin_layout Description
5039 Action Closes the current LyX window.
5040
5041 \end_layout
5042
5043 \begin_layout Description
5044 Syntax window-close
5045 \end_layout
5046
5047 \begin_layout Description
5048 Origin Abdel, 23 Oct 2006
5049 \end_layout
5050
5051 \begin_layout Subsection*
5052 LFUN_SPLIT_VIEW
5053 \end_layout
5054
5055 \begin_layout Description
5056 Action Creates another split view of current buffer.
5057
5058 \end_layout
5059
5060 \begin_layout Description
5061 Notion All split views act in the same way indpendently.
5062
5063 \end_layout
5064
5065 \begin_layout Description
5066 Syntax split-view <vertical|horizontal>
5067 \end_layout
5068
5069 \begin_layout Description
5070 Params horizontal : The work areas are laid out side by side.
5071
5072 \begin_inset Newline newline
5073 \end_inset
5074
5075  vertical   : The work areas laid out vertically.
5076
5077 \end_layout
5078
5079 \begin_layout Description
5080 Origin Abdel, 20 Feb 2008
5081 \end_layout
5082
5083 \begin_layout Subsection*
5084 LFUN_CLOSE_TAB_GROUP
5085 \end_layout
5086
5087 \begin_layout Description
5088 Action Close the current tab group.
5089
5090 \end_layout
5091
5092 \begin_layout Description
5093 Notion This only closes the work areas, not the buffer themselves.
5094  The still opened buffers can be visualized in another tab group.
5095
5096 \end_layout
5097
5098 \begin_layout Description
5099 Syntax close-tab-group
5100 \end_layout
5101
5102 \begin_layout Description
5103 Origin Abdel, 21 Feb 2008
5104 \end_layout
5105
5106 \begin_layout Subsection*
5107 LFUN_DIALOG_SHOW
5108 \end_layout
5109
5110 \begin_layout Description
5111 Action Shows hidden dialog or create new one for a given function/inset
5112  settings etc.
5113
5114 \end_layout
5115
5116 \begin_layout Description
5117 Syntax dialog-show <NAME> [<DATA>]
5118 \end_layout
5119
5120 \begin_layout Description
5121 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
5122
5123 \begin_inset Newline newline
5124 \end_inset
5125
5126  document|errorlist|ert|external|file|findreplace|float|graphics|
5127 \begin_inset Newline newline
5128 \end_inset
5129
5130  include|index|info|nomenclature|label|log|mathdelimiter|mathmatrix|
5131 \begin_inset Newline newline
5132 \end_inset
5133
5134  note|paragraph|prefs|print|ref|sendto|space|spellchecker|symbols|
5135 \begin_inset Newline newline
5136 \end_inset
5137
5138  tabular|tabularcreate|thesaurus|texinfo|toc|href|view-source|vspace
5139 \begin_inset Newline newline
5140 \end_inset
5141
5142  wrap|listings|<SPECIAL>
5143 \begin_inset Newline newline
5144 \end_inset
5145
5146  <SPECIAL>: latexlog|vclog
5147 \begin_inset Newline newline
5148 \end_inset
5149
5150  <DATA>: data, usually settings for the given dialog.
5151  Use debug mode for the details.
5152
5153 \end_layout
5154
5155 \begin_layout Description
5156 Origin leeming, 17 Jun 2003
5157 \end_layout
5158
5159 \begin_layout Subsection*
5160 LFUN_DIALOG_SHOW_NEW_INSET
5161 \end_layout
5162
5163 \begin_layout Description
5164 Action Shows hidden dialog or create new one for a given inset settings
5165  etc.
5166
5167 \end_layout
5168
5169 \begin_layout Description
5170 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given
5171  inset.
5172
5173 \end_layout
5174
5175 \begin_layout Description
5176 Syntax dialog-show-new-inset <NAME> [<DATA>]
5177 \end_layout
5178
5179 \begin_layout Description
5180 Params See LFUN_DIALOG_SHOW .
5181
5182 \end_layout
5183
5184 \begin_layout Description
5185 Origin leeming, 25 Feb 2003
5186 \end_layout
5187
5188 \begin_layout Subsection*
5189 LFUN_DIALOG_UPDATE
5190 \end_layout
5191
5192 \begin_layout Description
5193 Action Updates the dialog values from the inset/paragraph/document.
5194
5195 \end_layout
5196
5197 \begin_layout Description
5198 Syntax dialog-update <NAME>
5199 \end_layout
5200
5201 \begin_layout Description
5202 Params <NAME>: paragraph|prefs|<INSET>
5203 \begin_inset Newline newline
5204 \end_inset
5205
5206  <INSET>: inset name
5207 \end_layout
5208
5209 \begin_layout Description
5210 Origin leeming, 25 Feb 2003
5211 \end_layout
5212
5213 \begin_layout Subsection*
5214 LFUN_DIALOG_HIDE
5215 \end_layout
5216
5217 \begin_layout Description
5218 Action Hides showed dialog.
5219  Counterpart to LFUN_DIALOG_SHOW .
5220
5221 \end_layout
5222
5223 \begin_layout Description
5224 Syntax dialog-hide <NAME>
5225 \end_layout
5226
5227 \begin_layout Description
5228 Params See LFUN_DIALOG_SHOW .
5229
5230 \end_layout
5231
5232 \begin_layout Description
5233 Origin leeming, 25 Feb 2003
5234 \end_layout
5235
5236 \begin_layout Subsection*
5237 LFUN_DIALOG_TOGGLE
5238 \end_layout
5239
5240 \begin_layout Description
5241 Action Toggles dialog between showed/hidden state.
5242
5243 \end_layout
5244
5245 \begin_layout Description
5246 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
5247
5248 \end_layout
5249
5250 \begin_layout Description
5251 Syntax dialog-toggle <NAME> [<DATA>]
5252 \end_layout
5253
5254 \begin_layout Description
5255 Params See LFUN_DIALOG_SHOW .
5256
5257 \end_layout
5258
5259 \begin_layout Description
5260 Origin JSpitzm, 30 Apr 2007
5261 \end_layout
5262
5263 \begin_layout Subsection*
5264 LFUN_DIALOG_DISCONNECT_INSET
5265 \end_layout
5266
5267 \begin_layout Description
5268 Action Closes opened connection to opened inset.
5269
5270 \end_layout
5271
5272 \begin_layout Description
5273 Notion Connection is used for apply functions.
5274
5275 \end_layout
5276
5277 \begin_layout Description
5278 Syntax dialog-disconnect-inset <INSET-NAME>
5279 \end_layout
5280
5281 \begin_layout Description
5282 Origin leeming, 25 Feb 2003
5283 \end_layout
5284
5285 \begin_layout Subsection*
5286 LFUN_MOUSE_PRESS
5287 \end_layout
5288
5289 \begin_layout Description
5290 Action This function is called when mouse button is pressed (inside workarea).Act
5291 ion depends on the context.
5292
5293 \end_layout
5294
5295 \begin_layout Description
5296 Notion This is internal LFUN, not to be used by users.
5297
5298 \end_layout
5299
5300 \begin_layout Description
5301 Origin Andre, 9 Aug 2002
5302 \end_layout
5303
5304 \begin_layout Subsection*
5305 LFUN_MOUSE_DOUBLE
5306 \end_layout
5307
5308 \begin_layout Description
5309 Action This function is called when double click on mouse button is pressed
5310  (inside workarea).
5311  Action depends on the context.
5312
5313 \end_layout
5314
5315 \begin_layout Description
5316 Notion This is internal LFUN, not to be used by users.
5317
5318 \end_layout
5319
5320 \begin_layout Description
5321 Origin Andre, 9 Aug 2002
5322 \end_layout
5323
5324 \begin_layout Subsection*
5325 LFUN_MOUSE_TRIPLE
5326 \end_layout
5327
5328 \begin_layout Description
5329 Action This function is called when triple click on mouse button is pressed
5330  (inside workarea).
5331  Action depends on the context.
5332
5333 \end_layout
5334
5335 \begin_layout Description
5336 Notion This is internal LFUN, not to be used by users.
5337
5338 \end_layout
5339
5340 \begin_layout Description
5341 Origin Andre, 9 Aug 2002
5342 \end_layout
5343
5344 \begin_layout Subsection*
5345 LFUN_MOUSE_MOTION
5346 \end_layout
5347
5348 \begin_layout Description
5349 Action This function is called when mouse cursor is moving over the text.Action
5350  depends on the context.
5351
5352 \end_layout
5353
5354 \begin_layout Description
5355 Notion This is internal LFUN, not to be used by users.
5356
5357 \end_layout
5358
5359 \begin_layout Description
5360 Origin Andre, 9 Aug 2002
5361 \end_layout
5362
5363 \begin_layout Subsection*
5364 LFUN_MOUSE_RELEASE
5365 \end_layout
5366
5367 \begin_layout Description
5368 Action This function is called when mouse button is released (inside workarea).Ac
5369 tion depends on the context.
5370
5371 \end_layout
5372
5373 \begin_layout Description
5374 Notion This is internal LFUN, not to be used by users.
5375
5376 \end_layout
5377
5378 \begin_layout Description
5379 Origin Andre, 9 Aug 2002
5380 \end_layout
5381
5382 \begin_layout Subsection*
5383 LFUN_KEYMAP_OFF
5384 \end_layout
5385
5386 \begin_layout Description
5387 Action Turn off the loaded keyboard map.
5388
5389 \end_layout
5390
5391 \begin_layout Description
5392 Syntax keymap-off
5393 \end_layout
5394
5395 \begin_layout Subsection*
5396 LFUN_KEYMAP_PRIMARY
5397 \end_layout
5398
5399 \begin_layout Description
5400 Action Turn on the primary keyboard map.
5401
5402 \end_layout
5403
5404 \begin_layout Description
5405 Notion Maps were widely used in past, when X-windows didn't have nowadays
5406  keyboard support.
5407  They can be still used to maintain uniform keyboard layout across the various
5408  plaforms.
5409
5410 \begin_inset Newline newline
5411 \end_inset
5412
5413  The language is to be set in the Preferences dialog.
5414
5415 \end_layout
5416
5417 \begin_layout Description
5418 Syntax keymap-primary
5419 \end_layout
5420
5421 \begin_layout Subsection*
5422 LFUN_KEYMAP_SECONDARY
5423 \end_layout
5424
5425 \begin_layout Description
5426 Action Turn on the secondary keyboard map.
5427
5428 \end_layout
5429
5430 \begin_layout Description
5431 Syntax keymap-secondary
5432 \end_layout
5433
5434 \begin_layout Subsection*
5435 LFUN_KEYMAP_TOGGLE
5436 \end_layout
5437
5438 \begin_layout Description
5439 Action Toggles keyboard maps (first/second/off).
5440
5441 \end_layout
5442
5443 \begin_layout Description
5444 Syntax keymap-toggle
5445 \end_layout
5446
5447 \begin_layout Description
5448 Origin leeming, 30 Mar 2004
5449 \end_layout
5450
5451 \begin_layout Subsection*
5452 LFUN_SERVER_GET_LAYOUT
5453 \end_layout
5454
5455 \begin_layout Description
5456 Action Returns the current layout (that is environment) name on the cursor
5457  position.
5458
5459 \end_layout
5460
5461 \begin_layout Description
5462 Syntax server-get-layout
5463 \end_layout
5464
5465 \begin_layout Subsection*
5466 LFUN_SERVER_GET_FILENAME
5467 \end_layout
5468
5469 \begin_layout Description
5470 Action Returns path and file name of the currently edited document.
5471
5472 \end_layout
5473
5474 \begin_layout Description
5475 Syntax server-get-filename
5476 \end_layout
5477
5478 \begin_layout Subsection*
5479 LFUN_SERVER_GOTO_FILE_ROW
5480 \end_layout
5481
5482 \begin_layout Description
5483 Action Sets the cursor position based on the row number of generated TeX
5484  file.
5485
5486 \end_layout
5487
5488 \begin_layout Description
5489 Syntax server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
5490 \end_layout
5491
5492 \begin_layout Description
5493 Origin Edmar, 23 Dec 1998
5494 \end_layout
5495
5496 \begin_layout Subsection*
5497 LFUN_SERVER_NOTIFY
5498 \end_layout
5499
5500 \begin_layout Description
5501 Action Sends notify message about the last key-sequence to client.
5502
5503 \end_layout
5504
5505 \begin_layout Description
5506 Notion This can be used to grab last key-sequence used inside the LyX window.
5507  See also Debug extensions section in Additional features manual.
5508
5509 \end_layout
5510
5511 \begin_layout Description
5512 Syntax server-notify
5513 \end_layout
5514
5515 \begin_layout Subsection*
5516 LFUN_SERVER_SET_XY
5517 \end_layout
5518
5519 \begin_layout Description
5520 Action Sets the cursor position based on the editing area coordinates (similar
5521  as clicking on that point with left mouse button).
5522
5523 \end_layout
5524
5525 \begin_layout Description
5526 Syntax server-set-xy <X> <Y>
5527 \end_layout
5528
5529 \begin_layout Subsection*
5530 LFUN_SERVER_GET_XY
5531 \end_layout
5532
5533 \begin_layout Description
5534 Action Returns the coordinates of cursor position in the editing area.
5535
5536 \end_layout
5537
5538 \begin_layout Description
5539 Syntax server-get-xy
5540 \end_layout
5541
5542 \begin_layout Subsection*
5543 LFUN_BUILD_PROGRAM
5544 \end_layout
5545
5546 \begin_layout Description
5547 Action Generates the code (literate programming).
5548
5549 \end_layout
5550
5551 \begin_layout Description
5552 Notion Latex file with extension literate_extension is generated.
5553  Then LyX invokes build_command (with a default of``make'') to generate
5554  the code and build_error_filter to process the compilation error messages.
5555
5556 \begin_inset Newline newline
5557 \end_inset
5558
5559  In case you want to process your literate file with a script, or some other
5560  program, just insert in your lyxrc file an entry with:
5561 \begin_inset Newline newline
5562 \end_inset
5563
5564  build_command "my_script my_arguments"
5565 \begin_inset Newline newline
5566 \end_inset
5567
5568  The build_error_filter differs from the literate_error_filter only in that
5569  the former will identify error messages from your compiler.
5570
5571 \end_layout
5572
5573 \begin_layout Description
5574 Syntax build-program
5575 \end_layout
5576
5577 \begin_layout Subsection*
5578 LFUN_BUFFER_AUTO_SAVE
5579 \end_layout
5580
5581 \begin_layout Description
5582 Action Saves the current buffer to a temporary file.
5583
5584 \end_layout
5585
5586 \begin_layout Description
5587 Notion Saves the current buffer to a file named "#filename#".
5588  This LFUN is called automatically by LyX, to "autosave" the current buffer.
5589
5590 \end_layout
5591
5592 \begin_layout Description
5593 Syntax buffer-auto-save
5594 \end_layout
5595
5596 \begin_layout Subsection*
5597 LFUN_BUFFER_CHILD_OPEN
5598 \end_layout
5599
5600 \begin_layout Description
5601 Action Loads the given child document.
5602
5603 \end_layout
5604
5605 \begin_layout Description
5606 Notion The current document is treated as a parent.
5607
5608 \end_layout
5609
5610 \begin_layout Description
5611 Syntax buffer-child-open <FILE>
5612 \end_layout
5613
5614 \begin_layout Description
5615 Params <FILE>: Filename of the child.
5616  The directory of the parent is assumed by default.
5617
5618 \end_layout
5619
5620 \begin_layout Description
5621 Origin Ale, 28 May 1997
5622 \end_layout
5623
5624 \begin_layout Subsection*
5625 LFUN_BUFFER_CHKTEX
5626 \end_layout
5627
5628 \begin_layout Description
5629 Action Runs chktex for the current document.
5630
5631 \end_layout
5632
5633 \begin_layout Description
5634 Syntax buffer-chktex
5635 \end_layout
5636
5637 \begin_layout Description
5638 Origin Asger, 30 Oct 1997
5639 \end_layout
5640
5641 \begin_layout Subsection*
5642 LFUN_BUFFER_TOGGLE_COMPRESSION
5643 \end_layout
5644
5645 \begin_layout Description
5646 Action Toggles compression of the current document on/off.
5647
5648 \end_layout
5649
5650 \begin_layout Description
5651 Syntax buffer-toggle-compression
5652 \end_layout
5653
5654 \begin_layout Description
5655 Origin bpeng, 27 Apr 2006
5656 \end_layout
5657
5658 \begin_layout Subsection*
5659 LFUN_BUFFER_CLOSE
5660 \end_layout
5661
5662 \begin_layout Description
5663 Action Closes the current buffer.
5664
5665 \end_layout
5666
5667 \begin_layout Description
5668 Notion Closes the current buffer, asking whether to save it, etc, if the
5669  buffer has been modified.
5670
5671 \end_layout
5672
5673 \begin_layout Description
5674 Syntax buffer-close
5675 \end_layout
5676
5677 \begin_layout Subsection*
5678 LFUN_BUFFER_EXPORT
5679 \end_layout
5680
5681 \begin_layout Description
5682 Action Exports the current buffer (document) to the given format.
5683
5684 \end_layout
5685
5686 \begin_layout Description
5687 Syntax buffer-export <FORMAT>
5688 \end_layout
5689
5690 \begin_layout Description
5691 Params <FORMAT> is either "custom" or one of the formats which you can find
5692  in Tools->Preferences->File formats->Format.
5693  Usual format you will enter is "pdf2" (pdflatex), "pdflatex" (plain tex
5694  for pdflatex) or "ps" for postscript.
5695
5696 \begin_inset Newline newline
5697 \end_inset
5698
5699  In case of "custom" you will be asked for a format you want to start from
5700  and for the command that you want to apply to this format.
5701  Internally the control is then passed to LFUN_BUFFER_EXPORT_CUSTOM.
5702
5703 \end_layout
5704
5705 \begin_layout Description
5706 Origin Lgb, 29 Jul 1997
5707 \end_layout
5708
5709 \begin_layout Subsection*
5710 LFUN_BUFFER_EXPORT_CUSTOM
5711 \end_layout
5712
5713 \begin_layout Description
5714 Action Exports the current buffer (document) from the given format using
5715  the given command on it.
5716
5717 \end_layout
5718
5719 \begin_layout Description
5720 Syntax buffer-export-custom <FORMAT> <COMMAND>
5721 \end_layout
5722
5723 \begin_layout Description
5724 Params <FORMAT> format to start from (LyX will care to produce such intermediate
5725  file).
5726
5727 \begin_inset Newline newline
5728 \end_inset
5729
5730  <COMMAND> this command will be launched on the file.
5731  Note that you can use "$$FName" string to qualify the intermediate file.
5732
5733 \end_layout
5734
5735 \begin_layout Description
5736 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
5737 \end_layout
5738
5739 \begin_layout Description
5740 Origin leeming, 27 Mar 2004
5741 \end_layout
5742
5743 \begin_layout Subsection*
5744 LFUN_BUFFER_PRINT
5745 \end_layout
5746
5747 \begin_layout Description
5748 Action Prints the current document.
5749
5750 \end_layout
5751
5752 \begin_layout Description
5753 Notion Many settings can be given via the preferences dialog.
5754
5755 \end_layout
5756
5757 \begin_layout Description
5758 Syntax buffer-print <TARGET> <TARGET-NAME> <COMMAND>
5759 \end_layout
5760
5761 \begin_layout Description
5762 Params <TARGET> is either "printer" or "file".
5763
5764 \begin_inset Newline newline
5765 \end_inset
5766
5767  <TARGER-NAME> is either "default" or file name or printer name.
5768
5769 \begin_inset Newline newline
5770 \end_inset
5771
5772  <COMMAND> command ensuring the printing job.
5773
5774 \end_layout
5775
5776 \begin_layout Description
5777 Sample buffer-print file "/trash/newfile1.ps" "dvips"
5778 \end_layout
5779
5780 \begin_layout Description
5781 Origin leeming, 28 Mar 2004
5782 \end_layout
5783
5784 \begin_layout Subsection*
5785 LFUN_BUFFER_IMPORT
5786 \end_layout
5787
5788 \begin_layout Description
5789 Action Import a given file as a lyx document.
5790
5791 \end_layout
5792
5793 \begin_layout Description
5794 Notion File can be imported iff lyx file format is (transitively) reachable
5795  via defined convertors in preferences.
5796  Look into File->Import menu to get an idea of the currently active import
5797  formats.
5798
5799 \end_layout
5800
5801 \begin_layout Description
5802 Syntax buffer-import <FORMAT> [<FILE>]
5803 \end_layout
5804
5805 \begin_layout Description
5806 Origin Asger, 24 Jul 1998
5807 \end_layout
5808
5809 \begin_layout Subsection*
5810 LFUN_BUFFER_NEW
5811 \end_layout
5812
5813 \begin_layout Description
5814 Action Creates a new buffer (that is, document).
5815
5816 \end_layout
5817
5818 \begin_layout Description
5819 Notion Implicit path can be set in Preferences dialog.
5820
5821 \end_layout
5822
5823 \begin_layout Description
5824 Syntax buffer-new [<FILE>]
5825 \end_layout
5826
5827 \begin_layout Description
5828 Params <FILE>: filename of created file with absolute path.
5829
5830 \end_layout
5831
5832 \begin_layout Subsection*
5833 LFUN_BUFFER_NEW_TEMPLATE
5834 \end_layout
5835
5836 \begin_layout Description
5837 Action Creates a new buffer (that is, document) from a template.
5838
5839 \end_layout
5840
5841 \begin_layout Description
5842 Notion Path for new files and templates can be set in Preferences dialog.
5843  Template will be asked for via Open-dialog.
5844
5845 \end_layout
5846
5847 \begin_layout Description
5848 Syntax buffer-new-template [<FILE>]
5849 \end_layout
5850
5851 \begin_layout Description
5852 Params <FILE>: filename of created file with absolute path.
5853
5854 \end_layout
5855
5856 \begin_layout Subsection*
5857 LFUN_BUFFER_RELOAD
5858 \end_layout
5859
5860 \begin_layout Description
5861 Action Reverts opened document.
5862
5863 \end_layout
5864
5865 \begin_layout Description
5866 Syntax buffer-reload
5867 \end_layout
5868
5869 \begin_layout Description
5870 Origin Asger, 2 Feb 1997
5871 \end_layout
5872
5873 \begin_layout Subsection*
5874 LFUN_BUFFER_SWITCH
5875 \end_layout
5876
5877 \begin_layout Description
5878 Action Switch to the given buffer.
5879
5880 \end_layout
5881
5882 \begin_layout Description
5883 Notion This is useful also in case you need simultaneously more views of
5884  the edited document in different LyX windows.
5885
5886 \end_layout
5887
5888 \begin_layout Description
5889 Syntax buffer-new-template <BUFFER>
5890 \end_layout
5891
5892 \begin_layout Description
5893 Params <BUFFER>: already opened document which is to be shown.
5894
5895 \end_layout
5896
5897 \begin_layout Subsection*
5898 LFUN_BUFFER_TOGGLE_READ_ONLY
5899 \end_layout
5900
5901 \begin_layout Description
5902 Action Toggle editing mode of the current document between read/write and
5903  read-only.
5904
5905 \end_layout
5906
5907 \begin_layout Description
5908 Notion In the ->Readonly mode checks-in/commits the data if the file is
5909  under version control.
5910  In the Readonly-> mode checkouts the data from repository.
5911
5912 \begin_inset Newline newline
5913 \end_inset
5914
5915  If these operations fail, buffer won't be toggled.
5916
5917 \end_layout
5918
5919 \begin_layout Description
5920 Syntax buffer-toggle-read-only
5921 \end_layout
5922
5923 \begin_layout Description
5924 Origin Lgb, 27 May 1997
5925 \end_layout
5926
5927 \begin_layout Subsection*
5928 LFUN_BUFFER_VIEW
5929 \end_layout
5930
5931 \begin_layout Description
5932 Action Displays current buffer in chosen format.
5933
5934 \end_layout
5935
5936 \begin_layout Description
5937 Notion Displays the contents of the current buffer in the chosen format,
5938  for example, PDF or DVI.
5939  This runs the necessary converter, calls the defined viewer, and so forth.
5940
5941 \end_layout
5942
5943 \begin_layout Description
5944 Syntax buffer-view <FORMAT>
5945 \end_layout
5946
5947 \begin_layout Description
5948 Params <FORMAT>: The format to display, where this is one of the formats
5949  defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
5950
5951 \end_layout
5952
5953 \begin_layout Subsection*
5954 LFUN_BUFFER_UPDATE
5955 \end_layout
5956
5957 \begin_layout Description
5958 Action Exports the current document and put the result into the temporary
5959  directory.
5960
5961 \end_layout
5962
5963 \begin_layout Description
5964 Notion In case you are already viewing the exported document (see LFUN_BUFFER_VI
5965 EW) the output will be rewriten - updated.
5966  This is useful in case your viewer is able to detect such changes (e.g.
5967  ghostview for postscript).
5968
5969 \end_layout
5970
5971 \begin_layout Description
5972 Syntax buffer-update <FORMAT>
5973 \end_layout
5974
5975 \begin_layout Description
5976 Params <FORMAT>: The format to display, where this is one of the formats
5977  defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
5978
5979 \end_layout
5980
5981 \begin_layout Description
5982 Origin Dekel, 5 Aug 2000
5983 \end_layout
5984
5985 \begin_layout Subsection*
5986 LFUN_BUFFER_WRITE
5987 \end_layout
5988
5989 \begin_layout Description
5990 Action Saves the current buffer.
5991
5992 \end_layout
5993
5994 \begin_layout Description
5995 Notion Saves the current buffer to disk, using the filename that is already
5996  associated with the buffer, asking for one if none is yet assigned.
5997
5998 \end_layout
5999
6000 \begin_layout Description
6001 Syntax buffer-write
6002 \end_layout
6003
6004 \begin_layout Subsection*
6005 LFUN_BUFFER_WRITE_AS
6006 \end_layout
6007
6008 \begin_layout Description
6009 Action Rename and save current buffer.
6010
6011 \end_layout
6012
6013 \begin_layout Description
6014 Syntax buffer-write-as <FILENAME>
6015 \end_layout
6016
6017 \begin_layout Description
6018 Params <FILENAME>: New name of the buffer/file.
6019  A relative path is with respect to the original location of the buffer/file.
6020
6021 \end_layout
6022
6023 \begin_layout Subsection*
6024 LFUN_BUFFER_WRITE_ALL
6025 \end_layout
6026
6027 \begin_layout Description
6028 Action Save all changed documents.
6029
6030 \end_layout
6031
6032 \begin_layout Description
6033 Syntax buffer-write-all
6034 \end_layout
6035
6036 \begin_layout Description
6037 Origin rgh, gpothier 6 Aug 2007
6038 \end_layout
6039
6040 \begin_layout Subsection*
6041 LFUN_BUFFER_NEXT
6042 \end_layout
6043
6044 \begin_layout Description
6045 Action Switch to the next opened document.
6046
6047 \end_layout
6048
6049 \begin_layout Description
6050 Notion Note that this does not necessarily mean next in tabbar (for full
6051  list see View menu).
6052
6053 \end_layout
6054
6055 \begin_layout Description
6056 Syntax buffer-next
6057 \end_layout
6058
6059 \begin_layout Subsection*
6060 LFUN_BUFFER_PREVIOUS
6061 \end_layout
6062
6063 \begin_layout Description
6064 Action Switch to the previous opened document.
6065
6066 \end_layout
6067
6068 \begin_layout Description
6069 Syntax buffer-previous
6070 \end_layout
6071
6072 \begin_layout Subsection*
6073 LFUN_MASTER_BUFFER_UPDATE
6074 \end_layout
6075
6076 \begin_layout Description
6077 Action When run from a child document, this updates (exports) document built
6078  from the master buffer.
6079  If a master is not found, it updates the current buffer.
6080
6081 \end_layout
6082
6083 \begin_layout Description
6084 Syntax master-buffer-update
6085 \end_layout
6086
6087 \begin_layout Description
6088 Origin Tommaso, 20 Sep 2007
6089 \end_layout
6090
6091 \begin_layout Subsection*
6092 LFUN_MASTER_BUFFER_VIEW
6093 \end_layout
6094
6095 \begin_layout Description
6096 Action When run from a child document, this command shows a preview built
6097  from the master buffer.
6098  If a master is not found, it previews the current buffer.
6099
6100 \end_layout
6101
6102 \begin_layout Description
6103 Syntax master-buffer-view
6104 \end_layout
6105
6106 \begin_layout Description
6107 Origin Tommaso, 20 Sep 2007
6108 \end_layout
6109
6110 \begin_layout Subsection*
6111 LFUN_BUFFER_LANGUAGE
6112 \end_layout
6113
6114 \begin_layout Description
6115 Action Set language of the current document.
6116
6117 \end_layout
6118
6119 \begin_layout Description
6120 Syntax buffer-language <LANG>
6121 \end_layout
6122
6123 \begin_layout Description
6124 Params <LANG>: language name.
6125  See lib/languages for list.
6126
6127 \end_layout
6128
6129 \begin_layout Description
6130 Origin leeming, 30 Mar 2004
6131 \end_layout
6132
6133 \begin_layout Subsection*
6134 LFUN_BUFFER_SAVE_AS_DEFAULT
6135 \end_layout
6136
6137 \begin_layout Description
6138 Action Save the current document settings as default.
6139
6140 \end_layout
6141
6142 \begin_layout Description
6143 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
6144
6145 \end_layout
6146
6147 \begin_layout Description
6148 Syntax buffer-save-as-default [<ARGS>]
6149 \end_layout
6150
6151 \begin_layout Description
6152 Params <ARGS>: contains the particular settings to be saved.
6153  They obey the syntax you can find in document header of usual .lyx file.
6154
6155 \end_layout
6156
6157 \begin_layout Description
6158 Origin leeming, 30 Mar 2004
6159 \end_layout
6160
6161 \begin_layout Subsection*
6162 LFUN_BUFFER_PARAMS_APPLY
6163 \end_layout
6164
6165 \begin_layout Description
6166 Action Apply the given settings to the current document.
6167
6168 \end_layout
6169
6170 \begin_layout Description
6171 Syntax buffer-params-apply [<ARGS>]
6172 \end_layout
6173
6174 \begin_layout Description
6175 Params <ARGS>: contains the particular settings to be saved.
6176  They obey the syntax you can find in document header of usual .lyx file.
6177
6178 \end_layout
6179
6180 \begin_layout Description
6181 Origin leeming, 30 Mar 2004
6182 \end_layout
6183
6184 \begin_layout Subsection*
6185 LFUN_FILE_INSERT
6186 \end_layout
6187
6188 \begin_layout Description
6189 Action Inserts another LyX file.
6190
6191 \end_layout
6192
6193 \begin_layout Description
6194 Syntax file-insert [<FILE>]
6195 \end_layout
6196
6197 \begin_layout Description
6198 Params <FILE>: Filename to be inserted.
6199
6200 \end_layout
6201
6202 \begin_layout Subsection*
6203 LFUN_FILE_INSERT_PLAINTEXT
6204 \end_layout
6205
6206 \begin_layout Description
6207 Action Inserts plain text file.
6208
6209 \end_layout
6210
6211 \begin_layout Description
6212 Syntax file-insert-plaintext [<FILE>]
6213 \end_layout
6214
6215 \begin_layout Description
6216 Params <FILE>: Filename to be inserted.
6217
6218 \end_layout
6219
6220 \begin_layout Description
6221 Origin CFO-G, 19 Nov 1997
6222 \end_layout
6223
6224 \begin_layout Subsection*
6225 LFUN_FILE_INSERT_PLAINTEXT_PARA
6226 \end_layout
6227
6228 \begin_layout Description
6229 Action Inserts plain text file as paragraph (i.e.
6230  join lines).
6231
6232 \end_layout
6233
6234 \begin_layout Description
6235 Syntax file-insert-plaintext-para [<FILE>]
6236 \end_layout
6237
6238 \begin_layout Description
6239 Params <FILE>: Filename to be inserted.
6240
6241 \end_layout
6242
6243 \begin_layout Description
6244 Origin Levon, 14 Feb 2001
6245 \end_layout
6246
6247 \begin_layout Subsection*
6248 LFUN_FILE_OPEN
6249 \end_layout
6250
6251 \begin_layout Description
6252 Action Open LyX document.
6253
6254 \end_layout
6255
6256 \begin_layout Description
6257 Syntax file-open [<FILE>]
6258 \end_layout
6259
6260 \begin_layout Description
6261 Params <FILE>: Filename to be opened.
6262
6263 \end_layout
6264
6265 \begin_layout Subsection*
6266 LFUN_CALL
6267 \end_layout
6268
6269 \begin_layout Description
6270 Action Executes a command defined in a .def file.
6271
6272 \end_layout
6273
6274 \begin_layout Description
6275 Notion The definitions are by default read from lib/commands/default.def.
6276
6277 \begin_inset Newline newline
6278 \end_inset
6279
6280  A .def file allows to define a command with
6281 \backslash
6282 define "<NAME>" "<LFUN>" where <NAME> is the name of the new command and
6283  <LFUN> is the lfun code to be executed (see e.g.
6284  LFUN_COMMAND_SEQUENCE).
6285
6286 \backslash
6287 def_file "FileName" allows to include another .def file.
6288
6289 \begin_inset Newline newline
6290 \end_inset
6291
6292  This is particularly useful in connection with toolbar buttons: Since the
6293  name of the button image for this lfun is lib/images/commands/<NAME>.png
6294  this is the way to assign an image to a complex command-sequence.
6295
6296 \end_layout
6297
6298 \begin_layout Description
6299 Syntax call <NAME>
6300 \end_layout
6301
6302 \begin_layout Description
6303 Params <NAME>: Name of the command that must be called.
6304
6305 \end_layout
6306
6307 \begin_layout Description
6308 Origin broider, 2 Oct 2007
6309 \end_layout
6310
6311 \begin_layout Subsection*
6312 LFUN_META_PREFIX
6313 \end_layout
6314
6315 \begin_layout Description
6316 Action Simulate halting Meta key (Alt key on PCs).
6317
6318 \end_layout
6319
6320 \begin_layout Description
6321 Notion Used for buffer editation not for GUI control.
6322
6323 \end_layout
6324
6325 \begin_layout Description
6326 Syntax meta-prefix
6327 \end_layout
6328
6329 \begin_layout Subsection*
6330 LFUN_CANCEL
6331 \end_layout
6332
6333 \begin_layout Description
6334 Action Cancels sequence prepared by LFUN_META_PREFIX .
6335
6336 \end_layout
6337
6338 \begin_layout Description
6339 Syntax cancel
6340 \end_layout
6341
6342 \begin_layout Subsection*
6343 LFUN_COMMAND_EXECUTE
6344 \end_layout
6345
6346 \begin_layout Description
6347 Action Opens the minibuffer toolbar so that the user can type in there.
6348
6349 \end_layout
6350
6351 \begin_layout Description
6352 Notion Usually bound to M-x shortcut.
6353
6354 \end_layout
6355
6356 \begin_layout Description
6357 Syntax command-execute
6358 \end_layout
6359
6360 \begin_layout Subsection*
6361 LFUN_COMMAND_PREFIX
6362 \end_layout
6363
6364 \begin_layout Description
6365 Action Return the current key sequence and available options as a string.
6366
6367 \end_layout
6368
6369 \begin_layout Description
6370 Notion No options are added if no current map exists.
6371
6372 \begin_inset Newline newline
6373 \end_inset
6374
6375  This is probably usable only with connection to lyxserver.
6376
6377 \end_layout
6378
6379 \begin_layout Description
6380 Syntax command-prefix
6381 \end_layout
6382
6383 \begin_layout Subsection*
6384 LFUN_COMMAND_SEQUENCE
6385 \end_layout
6386
6387 \begin_layout Description
6388 Action Run more commands (LFUN and its parameters) in a sequence.
6389
6390 \end_layout
6391
6392 \begin_layout Description
6393 Syntax command-sequence <CMDS>
6394 \end_layout
6395
6396 \begin_layout Description
6397 Params <CMDS>: Sequence of commands separated by semicolons.
6398
6399 \end_layout
6400
6401 \begin_layout Description
6402 Sample command-sequence cut; ert-insert; self-insert ; paste; self-insert
6403  {}; inset-toggle;
6404 \end_layout
6405
6406 \begin_layout Description
6407 Origin Andre, 11 Nov 1999
6408 \end_layout
6409
6410 \begin_layout Subsection*
6411 LFUN_COMMAND_ALTERNATIVES
6412 \end_layout
6413
6414 \begin_layout Description
6415 Action Runs the first listed command that is enabled.
6416
6417 \end_layout
6418
6419 \begin_layout Description
6420 Notion This can be used to bind multiple functions to a single key, and
6421  then which one is used will depend upon the context.
6422
6423 \end_layout
6424
6425 \begin_layout Description
6426 Syntax command-alternatives <CMDS>
6427 \end_layout
6428
6429 \begin_layout Description
6430 Params <CMDS>: Sequence of commands separated by semicolons.
6431
6432 \end_layout
6433
6434 \begin_layout Description
6435 Sample command-alternatives completion-accept;cell-forward
6436 \end_layout
6437
6438 \begin_layout Description
6439 Origin rgh, 24 September 2008
6440 \end_layout
6441
6442 \begin_layout Subsection*
6443 LFUN_MESSAGE
6444 \end_layout
6445
6446 \begin_layout Description
6447 Action Shows message in statusbar (for script purposes).
6448
6449 \end_layout
6450
6451 \begin_layout Description
6452 Syntax message <STRING>
6453 \end_layout
6454
6455 \begin_layout Description
6456 Origin Lgb, 8 Apr 2001
6457 \end_layout
6458
6459 \begin_layout Subsection*
6460 LFUN_PREFERENCES_SAVE
6461 \end_layout
6462
6463 \begin_layout Description
6464 Action Save user preferences.
6465
6466 \end_layout
6467
6468 \begin_layout Description
6469 Syntax preferences-save
6470 \end_layout
6471
6472 \begin_layout Description
6473 Origin Lgb, 27 Nov 1999
6474 \end_layout
6475
6476 \begin_layout Subsection*
6477 LFUN_RECONFIGURE
6478 \end_layout
6479
6480 \begin_layout Description
6481 Action Reconfigure the automatic settings.
6482
6483 \end_layout
6484
6485 \begin_layout Description
6486 Syntax reconfigure
6487 \end_layout
6488
6489 \begin_layout Description
6490 Origin Asger, 14 Feb 1997
6491 \end_layout
6492
6493 \begin_layout Subsection*
6494 LFUN_LYXRC_APPLY
6495 \end_layout
6496
6497 \begin_layout Description
6498 Action Apply the given settings to user preferences.
6499
6500 \end_layout
6501
6502 \begin_layout Description
6503 Syntax lyxrc-apply <SETTINGS>
6504 \end_layout
6505
6506 \begin_layout Description
6507 Params <SETTINGS>: settings which are to be set.
6508  Take a look into ~/.lyx/preferences to get an idea which commands to use
6509  and their syntax.
6510  lyx::LyXRC::LyXRCTags has the list of possible commands.
6511
6512 \end_layout
6513
6514 \begin_layout Subsection*
6515 LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
6516 \end_layout
6517
6518 \begin_layout Description
6519 Action Determine whether keep cursor inside the editing window regardless
6520  the scrollbar movement.
6521
6522 \end_layout
6523
6524 \begin_layout Description
6525 Syntax toggle-cursor-follows-scrollbar
6526 \end_layout
6527
6528 \begin_layout Description
6529 Origin ARRae, 2 Dec 1997
6530 \end_layout
6531
6532 \begin_layout Subsection*
6533 LFUN_SET_COLOR
6534 \end_layout
6535
6536 \begin_layout Description
6537 Action Set the given LyX color to the color defined by the X11 name given.
6538
6539 \end_layout
6540
6541 \begin_layout Description
6542 Notion A new color entry is created if the color is unknown.
6543  Color names can be stored as a part of user settings.
6544
6545 \end_layout
6546
6547 \begin_layout Description
6548 Syntax set-color <LYX_NAME> <X11_NAME>
6549 \end_layout
6550
6551 \begin_layout Description
6552 Origin SLior, 11 Jun 2000
6553 \end_layout
6554
6555 \begin_layout Subsection*
6556 LFUN_STATISTICS
6557 \end_layout
6558
6559 \begin_layout Description
6560 Action Count the statistics (number of words and characters) in the document
6561  or in the given selection.
6562
6563 \end_layout
6564
6565 \begin_layout Description
6566 Notion Note that this function gives the number of words/chars written,
6567  not the number of characters which will be typeset.
6568
6569 \end_layout
6570
6571 \begin_layout Description
6572 Syntax statistics
6573 \end_layout
6574
6575 \begin_layout Description
6576 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
6577 \end_layout
6578
6579 \begin_layout Subsection*
6580 LFUN_COMPLETION_INLINE
6581 \end_layout
6582
6583 \begin_layout Description
6584 Action Show the inline completion at the cursor position.
6585
6586 \end_layout
6587
6588 \begin_layout Description
6589 Syntax completion-inline
6590 \end_layout
6591
6592 \begin_layout Description
6593 Origin sts, Feb 19 2008
6594 \end_layout
6595
6596 \begin_layout Subsection*
6597 LFUN_COMPLETION_POPUP
6598 \end_layout
6599
6600 \begin_layout Description
6601 Action Show the completion popup at the cursor position.
6602
6603 \end_layout
6604
6605 \begin_layout Description
6606 Syntax completion-popup
6607 \end_layout
6608
6609 \begin_layout Description
6610 Origin sts, Feb 19 2008
6611 \end_layout
6612
6613 \begin_layout Subsection*
6614 LFUN_COMPLETION_COMPLETE
6615 \end_layout
6616
6617 \begin_layout Description
6618 Action Try to complete the word or command at the cursor position.
6619
6620 \end_layout
6621
6622 \begin_layout Description
6623 Syntax complete
6624 \end_layout
6625
6626 \begin_layout Description
6627 Origin sts, Feb 19 2008
6628 \end_layout
6629
6630 \begin_layout Subsection*
6631 LFUN_COMPLETION_CANCEL
6632 \end_layout
6633
6634 \begin_layout Description
6635 Action Try to cancel completion, either the popup or the inline completion
6636
6637 \end_layout
6638
6639 \begin_layout Description
6640 Syntax completion-cancel
6641 \end_layout
6642
6643 \begin_layout Description
6644 Origin sts, Sep 07 2008
6645 \end_layout
6646
6647 \begin_layout Subsection*
6648 LFUN_COMPLETION_ACCEPT
6649 \end_layout
6650
6651 \begin_layout Description
6652 Action Accept suggested completion.
6653
6654 \end_layout
6655
6656 \begin_layout Description
6657 Syntax completion-accept
6658 \end_layout
6659
6660 \begin_layout Description
6661 Origin sanda, Sep 08 2008
6662 \end_layout
6663
6664 \begin_layout Subsection*
6665 LFUN_BRANCH_ACTIVATE
6666 \end_layout
6667
6668 \begin_layout Description
6669 Action Activate the branch
6670 \end_layout
6671
6672 \begin_layout Description
6673 Syntax branch-activate <BRANCH>
6674 \end_layout
6675
6676 \begin_layout Description
6677 Params <BRANCH>: The branch to activate
6678 \end_layout
6679
6680 \begin_layout Description
6681 Sample lyx -e pdf2 -x "branch-activate answers" finalexam.lyx
6682 \begin_inset Newline newline
6683 \end_inset
6684
6685 could be used to export a pdf with the answers branch includedwithout one's
6686  having to open LyX and activate the branch manually.
6687 \end_layout
6688
6689 \begin_layout Description
6690 Origin rgh, 27 May 2008
6691 \end_layout
6692
6693 \begin_layout Subsection*
6694 LFUN_BRANCH_ACTIVATE
6695 \end_layout
6696
6697 \begin_layout Description
6698 Action De-activate the branch
6699 \end_layout
6700
6701 \begin_layout Description
6702 Syntax branch-deactivate <BRANCH>
6703 \end_layout
6704
6705 \begin_layout Description
6706 Params <BRANCH>: The branch to deactivate
6707 \end_layout
6708
6709 \begin_layout Description
6710 Origin rgh, 27 May 2008
6711 \end_layout
6712
6713 \begin_layout Subsection*
6714 LFUN_COPY_LABEL_AS_REF
6715 \end_layout
6716
6717 \begin_layout Description
6718 Action Copies the label at the cursor as a cross-reference to be pasted
6719  elsewhere.
6720
6721 \end_layout
6722
6723 \begin_layout Description
6724 Syntax copy-label-as-reference
6725 \end_layout
6726
6727 \begin_layout Description
6728 Origin sts, 16 Nov 2008
6729 \end_layout
6730
6731 \end_body
6732 \end_document