lib/doc/LFUNs.lyx

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