lib/doc/LFUNs.lyx

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