lib/doc/LFUNs.lyx

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