lib/doc/LFUNs.lyx

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