lib/doc/LFUNs.lyx

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