lib/doc/LFUNs.lyx

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