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