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-05
  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_RENAME
4147 \end_layout
4148
4149 \begin_layout Description
4150 Action Renames the document to another name.
4151 \end_layout
4152
4153 \begin_layout Description
4154 Notion Renaming with revision history is only supported by SVN.
4155  For CVS it is simulated by adding the document under a new name and deleting
4156  the old one.
4157  For RCS it is not supported.
4158  Disabled if uncommitted changes exist.
4159 \end_layout
4160
4161 \begin_layout Description
4162 Syntax vc-rename <FILENAME>
4163 \end_layout
4164
4165 \begin_layout Description
4166 Params <FILENAME>: New name of the document.
4167 \begin_inset Newline newline
4168 \end_inset
4169
4170 A file dialog is opened if no filename is given.
4171 \end_layout
4172
4173 \begin_layout Description
4174 Origin gb, 05 Feb 2013
4175 \end_layout
4176
4177 \begin_layout Subsection*
4178 LFUN_VC_COPY
4179 \end_layout
4180
4181 \begin_layout Description
4182 Action Copies the document to another name.
4183 \end_layout
4184
4185 \begin_layout Description
4186 Notion Copying with revision history is only supported by SVN.
4187  For RCS and CVS it is simulated by adding the document under a new name.
4188  Disabled if uncommitted changes exist.
4189 \end_layout
4190
4191 \begin_layout Description
4192 Syntax vc-copy <FILENAME>
4193 \end_layout
4194
4195 \begin_layout Description
4196 Params <FILENAME>: New name of the document.
4197 \begin_inset Newline newline
4198 \end_inset
4199
4200 A file dialog is opened if no filename is given.
4201 \end_layout
4202
4203 \begin_layout Description
4204 Origin gb, 05 Feb 2013
4205 \end_layout
4206
4207 \begin_layout Subsection*
4208 LFUN_VC_CHECK_IN
4209 \end_layout
4210
4211 \begin_layout Description
4212 Action Checks-in/commits the changes of the registered file to the repository.
4213 \end_layout
4214
4215 \begin_layout Description
4216 Notion In RCS case this also unlocks the file.
4217 \end_layout
4218
4219 \begin_layout Description
4220 Syntax vc-check-in
4221 \end_layout
4222
4223 \begin_layout Description
4224 Origin Lgb, 1 Jul 1997
4225 \end_layout
4226
4227 \begin_layout Subsection*
4228 LFUN_VC_CHECK_OUT
4229 \end_layout
4230
4231 \begin_layout Description
4232 Action Checks-out the document for edit (and locks it in some cases).
4233 \end_layout
4234
4235 \begin_layout Description
4236 Syntax vc-check-out
4237 \end_layout
4238
4239 \begin_layout Description
4240 Origin Lgb, 1 Jul 1997
4241 \end_layout
4242
4243 \begin_layout Subsection*
4244 LFUN_VC_REVERT
4245 \end_layout
4246
4247 \begin_layout Description
4248 Action Reverts the document to the last check-in/commit in VCS.
4249 \end_layout
4250
4251 \begin_layout Description
4252 Syntax vc-revert
4253 \end_layout
4254
4255 \begin_layout Description
4256 Origin Lgb, 1 Jul 1997
4257 \end_layout
4258
4259 \begin_layout Subsection*
4260 LFUN_VC_UNDO_LAST
4261 \end_layout
4262
4263 \begin_layout Description
4264 Action Undo last check-in.
4265 \end_layout
4266
4267 \begin_layout Description
4268 Notion This is currently implemented only for RCS.
4269 \end_layout
4270
4271 \begin_layout Description
4272 Syntax vc-check-out
4273 \end_layout
4274
4275 \begin_layout Description
4276 Origin Lgb, 1 Jul 1997
4277 \end_layout
4278
4279 \begin_layout Subsection*
4280 LFUN_VC_COMMAND
4281 \end_layout
4282
4283 \begin_layout Description
4284 Action Executes external command.
4285  This command is intended to support additional VCS commands.
4286 \end_layout
4287
4288 \begin_layout Description
4289 Syntax vc-command <FLAG> <PATH> <COMMAND>
4290 \end_layout
4291
4292 \begin_layout Description
4293 Params  <FLAG>: Flags for the command can be combined together.
4294 \begin_inset Newline newline
4295 \end_inset
4296
4297 U - dUmmy - no flags
4298 \begin_inset Newline newline
4299 \end_inset
4300
4301 D - Doc - need document loaded to proceed
4302 \begin_inset Newline newline
4303 \end_inset
4304
4305 I - dIrty - mark document dirty
4306 \begin_inset Newline newline
4307 \end_inset
4308
4309 R - Reload - ensure that the document is saved and reload it after command
4310  execution
4311 \begin_inset Newline newline
4312 \end_inset
4313
4314 M - Message - ask for input string (commit message)
4315 \begin_inset Newline newline
4316 \end_inset
4317
4318 <PATH>: path where to start.
4319  $$p will be replaced by the current document path.
4320 \begin_inset Newline newline
4321 \end_inset
4322
4323 <COMMAND>: command to execute.
4324  $$i/$$p/$$m will be replaced by the current document(with absolute path)/path/m
4325 essage.
4326 \end_layout
4327
4328 \begin_layout Description
4329 Sample vc-command DR $$p "svn up"
4330 \end_layout
4331
4332 \begin_layout Description
4333 Origin sanda, 13 Jan 2009
4334 \end_layout
4335
4336 \begin_layout Subsection*
4337 LFUN_VC_LOCKING_TOGGLE
4338 \end_layout
4339
4340 \begin_layout Description
4341 Action Toggles the locking property of the edited file.
4342 \end_layout
4343
4344 \begin_layout Description
4345 Notion This is currently implemented only for SVN.
4346 \end_layout
4347
4348 \begin_layout Description
4349 Syntax vc-locking-toggle
4350 \end_layout
4351
4352 \begin_layout Description
4353 Origin sanda, 25 Jun 2009
4354 \end_layout
4355
4356 \begin_layout Subsection*
4357 LFUN_VC_REPO_UPDATE
4358 \end_layout
4359
4360 \begin_layout Description
4361 Action Update the local archive directory in which resides the current document
4362  with the remote repository.
4363 \end_layout
4364
4365 \begin_layout Description
4366 Syntax vc-repo-update
4367 \end_layout
4368
4369 \begin_layout Description
4370 Origin sanda, 16 Oct 2009
4371 \end_layout
4372
4373 \begin_layout Subsection*
4374 LFUN_VC_COMPARE
4375 \end_layout
4376
4377 \begin_layout Description
4378 Action Compares two revisions of the same file under version control.
4379 \end_layout
4380
4381 \begin_layout Description
4382 Syntax vc-compare [<REV1>] [<REV2>]
4383 \end_layout
4384
4385 \begin_layout Description
4386 Params Revision number either points directly to commit in history or if
4387  negative number -x it points to (last commit - x).
4388 \begin_inset Newline newline
4389 \end_inset
4390
4391                In RCS we subtract only in the last number of revision specification.
4392  Special case "0" is reserved for the last committed revision.
4393 \begin_inset Newline newline
4394 \end_inset
4395
4396 <REV1>: Older file.
4397 \begin_inset Newline newline
4398 \end_inset
4399
4400                <REV2>: Newer file.
4401  Used only if REV1 > 0.
4402 \begin_inset Newline newline
4403 \end_inset
4404
4405 If no parameter is given, interactive dialog will be shown.
4406 \end_layout
4407
4408 \begin_layout Description
4409 Sample Compare current document against last commit
4410 \begin_inset Newline newline
4411 \end_inset
4412
4413                vc-compare 0
4414 \begin_inset Newline newline
4415 \end_inset
4416
4417 Compare current document against current revision - 5 commits
4418 \begin_inset Newline newline
4419 \end_inset
4420
4421                vc-compare -5
4422 \begin_inset Newline newline
4423 \end_inset
4424
4425 Compare revisions 120 and 155
4426 \begin_inset Newline newline
4427 \end_inset
4428
4429                vc-compare 120 155
4430 \end_layout
4431
4432 \begin_layout Description
4433 Origin sanda, 12 Feb 2010
4434 \end_layout
4435
4436 \begin_layout Subsection*
4437 LFUN_CHANGES_TRACK
4438 \end_layout
4439
4440 \begin_layout Description
4441 Action Toggles change tracking to on/off.
4442 \end_layout
4443
4444 \begin_layout Description
4445 Syntax changes-track
4446 \end_layout
4447
4448 \begin_layout Description
4449 Origin levon, 1 Oct 2002
4450 \end_layout
4451
4452 \begin_layout Subsection*
4453 LFUN_CHANGES_OUTPUT
4454 \end_layout
4455
4456 \begin_layout Description
4457 Action Toggles showing of change tracking in typesetted output.
4458 \end_layout
4459
4460 \begin_layout Description
4461 Syntax changes-output
4462 \end_layout
4463
4464 \begin_layout Description
4465 Origin jspitzm, 21 Jan 2005
4466 \end_layout
4467
4468 \begin_layout Subsection*
4469 LFUN_CHANGE_NEXT
4470 \end_layout
4471
4472 \begin_layout Description
4473 Action Moves the cursor to the position of the next change of the change
4474  tracking records.
4475 \end_layout
4476
4477 \begin_layout Description
4478 Syntax change-next
4479 \end_layout
4480
4481 \begin_layout Description
4482 Origin schmitt, 4 Oct 2006
4483 \end_layout
4484
4485 \begin_layout Subsection*
4486 LFUN_CHANGE_PREVIOUS
4487 \end_layout
4488
4489 \begin_layout Description
4490 Action Moves the cursor to the position of the previous change of the change
4491  tracking records.
4492 \end_layout
4493
4494 \begin_layout Description
4495 Syntax change-previous
4496 \end_layout
4497
4498 \begin_layout Description
4499 Origin vfr, 4 Apr 2009
4500 \end_layout
4501
4502 \begin_layout Subsection*
4503 LFUN_CHANGES_MERGE
4504 \end_layout
4505
4506 \begin_layout Description
4507 Action Open change tracking dialog for merging and moves the cursor to the
4508  position of the next change.
4509 \end_layout
4510
4511 \begin_layout Description
4512 Syntax changes-merge
4513 \end_layout
4514
4515 \begin_layout Description
4516 Origin Levon, 16 Oct 2002
4517 \end_layout
4518
4519 \begin_layout Subsection*
4520 LFUN_CHANGE_ACCEPT
4521 \end_layout
4522
4523 \begin_layout Description
4524 Action Accepts tracked change inside the selection.
4525 \end_layout
4526
4527 \begin_layout Description
4528 Syntax change-accept
4529 \end_layout
4530
4531 \begin_layout Description
4532 Origin Levon, 16 Oct 2002
4533 \end_layout
4534
4535 \begin_layout Subsection*
4536 LFUN_CHANGE_REJECT
4537 \end_layout
4538
4539 \begin_layout Description
4540 Action Rejects tracked change inside the selection.
4541 \end_layout
4542
4543 \begin_layout Description
4544 Syntax change-reject
4545 \end_layout
4546
4547 \begin_layout Description
4548 Origin Levon, 16 Oct 2002
4549 \end_layout
4550
4551 \begin_layout Subsection*
4552 LFUN_ALL_CHANGES_ACCEPT
4553 \end_layout
4554
4555 \begin_layout Description
4556 Action Accepts all tracked changes in the document.
4557 \end_layout
4558
4559 \begin_layout Description
4560 Syntax all-changes-accept
4561 \end_layout
4562
4563 \begin_layout Description
4564 Origin Levon, 16 Oct 2002
4565 \end_layout
4566
4567 \begin_layout Subsection*
4568 LFUN_ALL_CHANGES_REJECT
4569 \end_layout
4570
4571 \begin_layout Description
4572 Action Rejects all tracked changes in the document.
4573 \end_layout
4574
4575 \begin_layout Description
4576 Notion Reject does not work recursively; the user may have to repeat the
4577  operation.
4578 \end_layout
4579
4580 \begin_layout Description
4581 Syntax all-changes-reject
4582 \end_layout
4583
4584 \begin_layout Description
4585 Origin Levon, 16 Oct 2002
4586 \end_layout
4587
4588 \begin_layout Subsection*
4589 LFUN_INSET_APPLY
4590 \end_layout
4591
4592 \begin_layout Description
4593 Action Apply data for an inset.
4594 \end_layout
4595
4596 \begin_layout Description
4597 Notion LFUN_INSET_APPLY is sent from the dialogs when the data should be
4598  applied.
4599  This is either changed to LFUN_INSET_MODIFY or LFUN_INSET_INSERT depending
4600  on the context where it is called.
4601 \end_layout
4602
4603 \begin_layout Description
4604 Syntax inset-apply <ARGS>
4605 \end_layout
4606
4607 \begin_layout Description
4608 Params See LFUN_INSET_INSERT .
4609 \end_layout
4610
4611 \begin_layout Subsection*
4612 LFUN_INSET_DISSOLVE
4613 \end_layout
4614
4615 \begin_layout Description
4616 Action Dissolve the current inset into text.
4617 \end_layout
4618
4619 \begin_layout Description
4620 Syntax inset-dissolve [<INSET>]
4621 \end_layout
4622
4623 \begin_layout Description
4624 Params <INSET>: this can be used to make sure the right kind of inset is
4625  dissolved.
4626  For example "dissolve" entry in the charstyles sub-menu should only dissolve
4627  the charstyle inset, even if the cursor is inside several nested insets
4628  of different type.
4629 \begin_inset Newline newline
4630 \end_inset
4631
4632 For values see lyx::InsetLayout::lyxtype_ .
4633 \end_layout
4634
4635 \begin_layout Description
4636 Origin JSpitz, 7 Aug 2006
4637 \end_layout
4638
4639 \begin_layout Subsection*
4640 LFUN_INSET_INSERT
4641 \end_layout
4642
4643 \begin_layout Description
4644 Action Insert new inset (type given by the parameters).
4645 \end_layout
4646
4647 \begin_layout Description
4648 Syntax inset-insert <INSET> <ARGS>
4649 \end_layout
4650
4651 \begin_layout Description
4652 Params <INSET>: <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|
4653 \begin_inset Newline newline
4654 \end_inset
4655
4656                          hyperlink|include|index|label|line|nomencl|vspace|ref|toc|scri
4657 pt>
4658 \begin_inset Newline newline
4659 \end_inset
4660
4661 <ARGS>: depends on the given inset.
4662  Use "lyx -dbg action" to explore.
4663 \end_layout
4664
4665 \begin_layout Description
4666 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
4667 \backslash
4668 end_inset
4669 \begin_inset Newline newline
4670 \end_inset
4671
4672 where <label name> is the name of the referenced label and <Format> is one
4673  of the following:
4674 \begin_inset Newline newline
4675 \end_inset
4676
4677 ref -- <reference>
4678 \begin_inset Newline newline
4679 \end_inset
4680
4681 eqref -- (<reference>)
4682 \begin_inset Newline newline
4683 \end_inset
4684
4685 pageref -- <page>
4686 \begin_inset Newline newline
4687 \end_inset
4688
4689 vpageref -- on <page>
4690 \begin_inset Newline newline
4691 \end_inset
4692
4693 vref -- <reference> on <page>
4694 \begin_inset Newline newline
4695 \end_inset
4696
4697 formatted -- Formatted reference
4698 \end_layout
4699
4700 \begin_layout Subsection*
4701 LFUN_INSET_MODIFY
4702 \end_layout
4703
4704 \begin_layout Description
4705 Action Modify some properties of an inset.
4706 \end_layout
4707
4708 \begin_layout Description
4709 Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats,
4710  graphics, include, index, info, label, listings, newline, newpage, nomencl,
4711  note, phantom, ref, space, tabular, vspace, wrap insets.
4712 \end_layout
4713
4714 \begin_layout Description
4715 Syntax inset-modify <INSET> <ARGS>inset-modify changetype <TYPE>inset-modify
4716  tabular <FEATURE> [<ARG>]
4717 \end_layout
4718
4719 \begin_layout Description
4720 Params Generally see LFUN_INSET_INSERT for further details.
4721 \begin_inset Newline newline
4722 \end_inset
4723
4724 In case that <INSET> is "tabular" various math-environment features are
4725  handled as well, e.g.
4726  add-vline-left/right for the Grid/Array environment.
4727 \begin_inset Newline newline
4728 \end_inset
4729
4730 <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|copy-colum
4731 n| toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
4732  align-left|align-right|align-center|align-block|align-decimal|set-decimal-point
4733 | valign-top|valign-bottom|valign-middle|longtabular-align-left| longtabular-ali
4734 gn-center|longtabular-align-right|m-align-left|m-align-right| m-align-center|m-v
4735 align-top|m-valign-bottom|m-valign-middle|multicolumn| set-all-lines|unset-all-l
4736 ines|set-longtabular|unset-longtabular|set-pwidth| set-mpwidth|set-rotate-tabula
4737 r|unset-rotate-tabular|toggle-rotate-tabular| set-rotate-cell|unset-rotate-cell|
4738 toggle-rotate-cell|set-usebox|set-lthead| unset-lthead|set-ltfirsthead|unset-ltf
4739 irsthead|set-ltfoot|unset-ltfoot| set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|
4740 toggle-ltcaption| set-special-column|set-special-multicolumn|set-special-multiro
4741 w| set-booktabs|unset-booktabs|set-top-space|set-bottom-space| set-interline-spa
4742 ce|set-border-lines|tabular-valign-top| tabular-valign-middle|tabular-valign-bot
4743 tom|set-tabular-width
4744 \begin_inset Newline newline
4745 \end_inset
4746
4747 <ARG>: additional argument for some commands, use debug mode to explore
4748  its values.
4749 \end_layout
4750
4751 \begin_layout Description
4752 Sample inset-modify note Note Comment
4753 \begin_inset Newline newline
4754 \end_inset
4755
4756                inset-modify changetype Ovalbox
4757 \end_layout
4758
4759 \begin_layout Subsection*
4760 LFUN_INSET_DIALOG_UPDATE
4761 \end_layout
4762
4763 \begin_layout Description
4764 Action Updates the values inside the dialog from the inset.
4765 \end_layout
4766
4767 \begin_layout Description
4768 Notion This is an internal LFUN, not to be used by users.
4769  Called internally by LFUN_DIALOG_UPDATE
4770 \end_layout
4771
4772 \begin_layout Description
4773 Params <DIALOG-NAME>
4774 \end_layout
4775
4776 \begin_layout Description
4777 Origin leeming, 25 Feb 2003
4778 \end_layout
4779
4780 \begin_layout Subsection*
4781 LFUN_INSET_SETTINGS
4782 \end_layout
4783
4784 \begin_layout Description
4785 Action Open the inset's properties dialog.
4786 \end_layout
4787
4788 \begin_layout Description
4789 Notion Used for bibitem, bibtex, box, branch, citation, ert, external, float,
4790  graphics, href, include, index, index_print, label, line, listings, note,
4791  phantom, ref, space, tabular, vspace, wrap insets.
4792 \end_layout
4793
4794 \begin_layout Description
4795 Syntax inset-settings <INSET>
4796 \end_layout
4797
4798 \begin_layout Description
4799 Params <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
4800 \begin_inset Newline newline
4801 \end_inset
4802
4803 graphics|href|include|index|index_print|label|line|
4804 \begin_inset Newline newline
4805 \end_inset
4806
4807 listings|note|phantom|ref|space|tabular|vspace|wrap>.
4808 \end_layout
4809
4810 \begin_layout Subsection*
4811 LFUN_INSET_TOGGLE
4812 \end_layout
4813
4814 \begin_layout Description
4815 Action Toggles the collapsible inset at cursor position, or the inset we
4816  are currently in.
4817 \end_layout
4818
4819 \begin_layout Description
4820 Syntax inset-toggle [<ARG>]
4821 \end_layout
4822
4823 \begin_layout Description
4824 Params <ARG>: <open|close|toggle|assign>.
4825 \begin_inset Newline newline
4826 \end_inset
4827
4828 open/close/toggle are for collapsible insets.
4829  toggle is used when no argument is given.
4830 \begin_inset Newline newline
4831 \end_inset
4832
4833 assign synchronize the branch-inset with activation status of the branch.
4834  Used for global toggling when changed activation.
4835 \end_layout
4836
4837 \begin_layout Description
4838 Origin lasgouttes, 19 Jul 2001
4839 \end_layout
4840
4841 \begin_layout Subsection*
4842 LFUN_INSET_FORALL
4843 \end_layout
4844
4845 \begin_layout Description
4846 Action Apply the given commands on insets of a given name.
4847 \end_layout
4848
4849 \begin_layout Description
4850 Notion WARNING: use at your own risks; this function gives you too many
4851  ways of shooting yourself in the foot.
4852  A typical example is inset-forall Note note-insert which starts an infinite
4853  loop.
4854  This is mitigated by the fact that the number of actions is arbitrarily
4855  limited to 100000.
4856  Note also that inset-forall does not update metrics between iterations,
4857  which can lead to bugs.
4858  This has to be eventually fixed.
4859 \end_layout
4860
4861 \begin_layout Description
4862 Syntax inset-forall <NAME> <LFUN-COMMAND>
4863 \begin_inset Newline newline
4864 \end_inset
4865
4866 <NAME>: Type of Inset.
4867  If <NAME> is *, all insets are matched.
4868  The name is used like for InsetLayout in layout files: "Note" matches all
4869  note insets, while "Note:Note" only matches LyX yellow note insets.
4870 \end_layout
4871
4872 \begin_layout Description
4873 Sample Remove all index insets:
4874 \begin_inset Newline newline
4875 \end_inset
4876
4877                    inset-forall Index char-delete-forward
4878 \begin_inset Newline newline
4879 \end_inset
4880
4881 Close all Notes (also works for a particular branch, for example):
4882 \begin_inset Newline newline
4883 \end_inset
4884
4885                    inset-forall Note inset-toggle close
4886 \begin_inset Newline newline
4887 \end_inset
4888
4889 Transform all yellow notes to comments
4890 \begin_inset Newline newline
4891 \end_inset
4892
4893                    inset-forall Note:Note inset-modify note Note Comment
4894 \begin_inset Newline newline
4895 \end_inset
4896
4897 Try to put LyX in an infinite loop if there is at least a Note:
4898 \begin_inset Newline newline
4899 \end_inset
4900
4901                    inset-forall Note char-backward
4902 \end_layout
4903
4904 \begin_layout Description
4905 Origin lasgouttes, 27 Nov 2009
4906 \end_layout
4907
4908 \begin_layout Subsection*
4909 LFUN_GRAPHICS_RELOAD
4910 \end_layout
4911
4912 \begin_layout Description
4913 Action Reloads the image if necessary.
4914 \end_layout
4915
4916 \begin_layout Description
4917 Syntax graphics-reload
4918 \end_layout
4919
4920 \begin_layout Description
4921 Origin vfr, 10 Aug 2009
4922 \end_layout
4923
4924 \begin_layout Subsection*
4925 LFUN_SET_GRAPHICS_GROUP
4926 \end_layout
4927
4928 \begin_layout Description
4929 Action Set the group for the graphics inset on the cursor position.
4930 \end_layout
4931
4932 \begin_layout Description
4933 Syntax set-graphics-group [<GROUP>]
4934 \end_layout
4935
4936 \begin_layout Description
4937 Params <GROUP>: Id for an existing group.
4938  In case the Id is an empty string, the graphics inset is removed from the
4939  current group.
4940 \end_layout
4941
4942 \begin_layout Description
4943 Origin sanda, 6 May 2008
4944 \end_layout
4945
4946 \begin_layout Subsection*
4947 LFUN_FINISHED_FORWARD
4948 \end_layout
4949
4950 \begin_layout Description
4951 Action Moves the cursor out of the current slice, going forward.
4952 \end_layout
4953
4954 \begin_layout Description
4955 Notion Cursor movement within an inset may be different than cursor movement
4956  in the surrounding text.
4957  This action should be called automatically by the cursor movement within
4958  the inset, when movement within the inset has ceased (reached the end of
4959  the last paragraph, for example), in order to move correctly back into
4960  the surrounding text.
4961 \end_layout
4962
4963 \begin_layout Subsection*
4964 LFUN_FINISHED_BACKWARD
4965 \end_layout
4966
4967 \begin_layout Description
4968 Action Moves the cursor out of the current slice, going backwards.
4969 \end_layout
4970
4971 \begin_layout Description
4972 Notion See also LFUN_FINISHED_FORWARD.
4973 \end_layout
4974
4975 \begin_layout Subsection*
4976 LFUN_FINISHED_RIGHT
4977 \end_layout
4978
4979 \begin_layout Description
4980 Action Moves the cursor out of the current slice, going right.
4981 \end_layout
4982
4983 \begin_layout Description
4984 Notion See also LFUN_FINISHED_FORWARD
4985 \end_layout
4986
4987 \begin_layout Subsection*
4988 LFUN_FINISHED_LEFT
4989 \end_layout
4990
4991 \begin_layout Description
4992 Action Moves the cursor out of the current slice, going left.
4993 \end_layout
4994
4995 \begin_layout Description
4996 Notion See also LFUN_FINISHED_FORWARD.
4997 \end_layout
4998
4999 \begin_layout Subsection*
5000 LFUN_LANGUAGE
5001 \end_layout
5002
5003 \begin_layout Description
5004 Action Set language from the current cursor position.
5005 \end_layout
5006
5007 \begin_layout Description
5008 Syntax language <LANG> [set]
5009 \end_layout
5010
5011 \begin_layout Description
5012 Params <LANG>: Requested language.
5013  Look in lib/languages for the list.
5014  "language reset" or "language" (without param) reset to the document language.
5015  set: If used, the language will be set to the specified language.
5016  Otherwise, the language will be toggled (i.e., if the current language is
5017  LANG, switch to the document language or the default language, if LANG
5018  is the document language).
5019 \end_layout
5020
5021 \begin_layout Description
5022 Origin Dekel, 2 Mar 2000
5023 \end_layout
5024
5025 \begin_layout Subsection*
5026 LFUN_LABEL_GOTO
5027 \end_layout
5028
5029 \begin_layout Description
5030 Action Goto a label.
5031 \end_layout
5032
5033 \begin_layout Description
5034 Syntax label-goto [<LABEL>]
5035 \end_layout
5036
5037 \begin_layout Description
5038 Params <LABEL>: Requested label.
5039  If no label is given and reference is on cursor position, Bookmark 0 is
5040  saved and cursor moves to the position of referenced label.
5041 \end_layout
5042
5043 \begin_layout Description
5044 Origin Ale, 6 Aug 1997
5045 \end_layout
5046
5047 \begin_layout Subsection*
5048 LFUN_LABEL_INSERT
5049 \end_layout
5050
5051 \begin_layout Description
5052 Action Inserts label to text or displayed formula.
5053 \end_layout
5054
5055 \begin_layout Description
5056 Syntax label-insert [<LABEL>]
5057 \end_layout
5058
5059 \begin_layout Description
5060 Params <LABEL>: Requested label.
5061  If no label is given dialog requesting name will be opened.
5062 \end_layout
5063
5064 \begin_layout Subsection*
5065 LFUN_REFERENCE_NEXT
5066 \end_layout
5067
5068 \begin_layout Description
5069 Action Go to the next label or cross-reference.
5070 \end_layout
5071
5072 \begin_layout Description
5073 Syntax reference-next
5074 \end_layout
5075
5076 \begin_layout Description
5077 Origin Dekel, 14 Jan 2001
5078 \end_layout
5079
5080 \begin_layout Subsection*
5081 LFUN_BOOKMARK_GOTO
5082 \end_layout
5083
5084 \begin_layout Description
5085 Action Moves the cursor to the numbered bookmark, opening the file if necessary.
5086  Note that bookmarks are saved per-session, not per file.
5087 \end_layout
5088
5089 \begin_layout Description
5090 Notion Bookmark 0 has a special purpose.
5091  It is automatically set
5092 \begin_inset Newline newline
5093 \end_inset
5094
5095 1.
5096  to the paragraph you are currently editing
5097 \begin_inset Newline newline
5098 \end_inset
5099
5100 2.
5101  to the paragraph from where you are jumping to the last-edited position
5102  (jump-back feature)
5103 \begin_inset Newline newline
5104 \end_inset
5105
5106 3.
5107  when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
5108 \end_layout
5109
5110 \begin_layout Description
5111 Syntax bookmark-goto <NUMBER>
5112 \end_layout
5113
5114 \begin_layout Description
5115 Params <NUMBER>: the number of the bookmark to restore.
5116 \end_layout
5117
5118 \begin_layout Description
5119 Origin Dekel, 27 January 2001
5120 \end_layout
5121
5122 \begin_layout Subsection*
5123 LFUN_BOOKMARK_SAVE
5124 \end_layout
5125
5126 \begin_layout Description
5127 Action Save a bookmark.
5128 \end_layout
5129
5130 \begin_layout Description
5131 Notion Saves a numbered bookmark to the sessions file.
5132  The number must be between 1 and 9, inclusive.
5133  Note that bookmarks are saved per-session, not per file.
5134 \end_layout
5135
5136 \begin_layout Description
5137 Syntax bookmark-save <NUMBER>
5138 \end_layout
5139
5140 \begin_layout Description
5141 Params <NUMBER>: the number of the bookmark to save.
5142 \end_layout
5143
5144 \begin_layout Description
5145 Origin Dekel, 27 January 2001
5146 \end_layout
5147
5148 \begin_layout Subsection*
5149 LFUN_BOOKMARK_CLEAR
5150 \end_layout
5151
5152 \begin_layout Description
5153 Action Clears the list of saved bookmarks.
5154 \end_layout
5155
5156 \begin_layout Description
5157 Syntax bookmark-clear
5158 \end_layout
5159
5160 \begin_layout Description
5161 Origin bpeng, 31 October 2006
5162 \end_layout
5163
5164 \begin_layout Subsection*
5165 LFUN_HELP_OPEN
5166 \end_layout
5167
5168 \begin_layout Description
5169 Action Open the given help file according to the language setting.
5170 \end_layout
5171
5172 \begin_layout Description
5173 Syntax help-open <FILE>[.lyx]
5174 \end_layout
5175
5176 \begin_layout Description
5177 Params <FILE>: any document from (/usr/share/)doc directory.
5178 \end_layout
5179
5180 \begin_layout Description
5181 Origin Jug, 27 Jun 1999
5182 \end_layout
5183
5184 \begin_layout Subsection*
5185 LFUN_LYX_QUIT
5186 \end_layout
5187
5188 \begin_layout Description
5189 Action Terminates the current LyX instance.
5190 \end_layout
5191
5192 \begin_layout Description
5193 Notion Terminates the current LyX instance, asking whether to save modified
5194  documents, etc.
5195 \end_layout
5196
5197 \begin_layout Description
5198 Syntax lyx-quit
5199 \end_layout
5200
5201 \begin_layout Subsection*
5202 LFUN_TOOLBAR_TOGGLE
5203 \end_layout
5204
5205 \begin_layout Description
5206 Action Toggles visibility of a given toolbar between on/off/auto.
5207 \end_layout
5208
5209 \begin_layout Description
5210 Notion Skipping "auto" when allowauto is false.
5211 \end_layout
5212
5213 \begin_layout Description
5214 Syntax toolbar-toggle <NAME> [allowauto]
5215 \end_layout
5216
5217 \begin_layout Description
5218 Params <NAME>: standard|extra|table|math|mathmacrotemplate|
5219 \begin_inset Newline newline
5220 \end_inset
5221
5222 minibuffer|review|view/update|math_panels|vcs| view-others|update-others
5223 \end_layout
5224
5225 \begin_layout Description
5226 Origin Edwin, 21 May 2007
5227 \end_layout
5228
5229 \begin_layout Subsection*
5230 LFUN_MENU_OPEN
5231 \end_layout
5232
5233 \begin_layout Description
5234 Action Opens the menu given by its name.
5235 \end_layout
5236
5237 \begin_layout Description
5238 Syntax menu-open <NAME>
5239 \end_layout
5240
5241 \begin_layout Description
5242 Params <NAME>: menu name.
5243  See various .inc files in lib/ui for candidates.
5244 \end_layout
5245
5246 \begin_layout Subsection*
5247 LFUN_UI_TOGGLE
5248 \end_layout
5249
5250 \begin_layout Description
5251 Action Various UI visibility-toggling actions.
5252 \end_layout
5253
5254 \begin_layout Description
5255 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
5256 \end_layout
5257
5258 \begin_layout Description
5259 Params statusbar  : Toggle visibility of the statusbar.
5260 \begin_inset Newline newline
5261 \end_inset
5262
5263 menubar    : Toggle visibility of the menubar.
5264 \begin_inset Newline newline
5265 \end_inset
5266
5267 scrollbar  : Toggle visibility of the scrollbar.
5268 \begin_inset Newline newline
5269 \end_inset
5270
5271 frame      : Toggle visibility of the frames around editing window.
5272 \begin_inset Newline newline
5273 \end_inset
5274
5275 fullscreen : Toggle fullscreen mode.
5276  This also covers calling the previous functions.
5277  However LFUN_TOOLBAR_TOGGLE for the custom tweaks of the toolbars should
5278  be used.
5279 \end_layout
5280
5281 \begin_layout Description
5282 Origin sanda, 9 Feb 2007
5283 \end_layout
5284
5285 \begin_layout Subsection*
5286 LFUN_WINDOW_NEW
5287 \end_layout
5288
5289 \begin_layout Description
5290 Action Creates new empty LyX window.
5291 \end_layout
5292
5293 \begin_layout Description
5294 Notion Already opened documents from the previous window can be found under
5295  View menu.
5296 \end_layout
5297
5298 \begin_layout Description
5299 Syntax window-new [<GEOMETRY>]
5300 \end_layout
5301
5302 \begin_layout Description
5303 Params <GEOMETRY>: pass the geometry of the window.
5304  This parameter is currently accepted only on Windows platform.
5305 \end_layout
5306
5307 \begin_layout Description
5308 Origin Abdel, 21 Oct 2006
5309 \end_layout
5310
5311 \begin_layout Subsection*
5312 LFUN_WINDOW_CLOSE
5313 \end_layout
5314
5315 \begin_layout Description
5316 Action Closes the current LyX window.
5317 \end_layout
5318
5319 \begin_layout Description
5320 Syntax window-close
5321 \end_layout
5322
5323 \begin_layout Description
5324 Origin Abdel, 23 Oct 2006
5325 \end_layout
5326
5327 \begin_layout Subsection*
5328 LFUN_VIEW_SPLIT
5329 \end_layout
5330
5331 \begin_layout Description
5332 Action Creates another split view of current buffer.
5333 \end_layout
5334
5335 \begin_layout Description
5336 Notion All split views act in the same way independently.
5337 \end_layout
5338
5339 \begin_layout Description
5340 Syntax view-split <vertical|horizontal>
5341 \end_layout
5342
5343 \begin_layout Description
5344 Params horizontal : The work areas are laid out side by side.
5345 \begin_inset Newline newline
5346 \end_inset
5347
5348 vertical   : The work areas laid out vertically.
5349 \end_layout
5350
5351 \begin_layout Description
5352 Origin Abdel, 20 Feb 2008
5353 \end_layout
5354
5355 \begin_layout Subsection*
5356 LFUN_VIEW_CLOSE
5357 \end_layout
5358
5359 \begin_layout Description
5360 Action Close the current document work area.
5361 \end_layout
5362
5363 \begin_layout Description
5364 Notion Close the current work area.
5365  If no other work areas are showing the buffer, then close the associated
5366  buffer as well.
5367 \end_layout
5368
5369 \begin_layout Description
5370 Syntax view-close
5371 \end_layout
5372
5373 \begin_layout Description
5374 Origin Tommaso, 15 Sep 2012
5375 \end_layout
5376
5377 \begin_layout Subsection*
5378 LFUN_TAB_GROUP_CLOSE
5379 \end_layout
5380
5381 \begin_layout Description
5382 Action Close the current tab group.
5383 \end_layout
5384
5385 \begin_layout Description
5386 Notion This only closes the work areas, not the buffers themselves.
5387  The still opened buffers can be visualized in another tab group.
5388 \end_layout
5389
5390 \begin_layout Description
5391 Syntax tab-group-close
5392 \end_layout
5393
5394 \begin_layout Description
5395 Origin Abdel, 21 Feb 2008
5396 \end_layout
5397
5398 \begin_layout Subsection*
5399 LFUN_DIALOG_SHOW
5400 \end_layout
5401
5402 \begin_layout Description
5403 Action Shows hidden dialog or creates new one for a given function/inset
5404  settings etc.
5405 \end_layout
5406
5407 \begin_layout Description
5408 Syntax dialog-show <NAME> [<DATA>]
5409 \end_layout
5410
5411 \begin_layout Description
5412 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
5413 \begin_inset Newline newline
5414 \end_inset
5415
5416 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|
5417 \begin_inset Newline newline
5418 \end_inset
5419
5420 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimit
5421 er|
5422 \begin_inset Newline newline
5423 \end_inset
5424
5425 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|
5426 \begin_inset Newline newline
5427 \end_inset
5428
5429 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|
5430 \begin_inset Newline newline
5431 \end_inset
5432
5433 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL>
5434 \begin_inset Newline newline
5435 \end_inset
5436
5437 <SPECIAL>: latexlog|vclog
5438 \begin_inset Newline newline
5439 \end_inset
5440
5441 <DATA>: data, usually settings for the given dialog.
5442  Use debug mode for the details.
5443 \end_layout
5444
5445 \begin_layout Description
5446 Origin leeming, 17 Jun 2003
5447 \end_layout
5448
5449 \begin_layout Subsection*
5450 LFUN_DIALOG_SHOW_NEW_INSET
5451 \end_layout
5452
5453 \begin_layout Description
5454 Action Shows hidden dialog or create new one for a given inset settings
5455  etc.
5456 \end_layout
5457
5458 \begin_layout Description
5459 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given
5460  inset.
5461 \end_layout
5462
5463 \begin_layout Description
5464 Syntax dialog-show-new-inset <NAME> [<DATA>]
5465 \end_layout
5466
5467 \begin_layout Description
5468 Params See LFUN_DIALOG_SHOW .
5469 \end_layout
5470
5471 \begin_layout Description
5472 Origin leeming, 25 Feb 2003
5473 \end_layout
5474
5475 \begin_layout Subsection*
5476 LFUN_DIALOG_UPDATE
5477 \end_layout
5478
5479 \begin_layout Description
5480 Action Updates the dialog values from the inset/paragraph/document.
5481 \end_layout
5482
5483 \begin_layout Description
5484 Syntax dialog-update <NAME>
5485 \end_layout
5486
5487 \begin_layout Description
5488 Params <NAME>: paragraph|prefs|<INSET>
5489 \begin_inset Newline newline
5490 \end_inset
5491
5492 <INSET>: inset name
5493 \end_layout
5494
5495 \begin_layout Description
5496 Origin leeming, 25 Feb 2003
5497 \end_layout
5498
5499 \begin_layout Subsection*
5500 LFUN_DIALOG_HIDE
5501 \end_layout
5502
5503 \begin_layout Description
5504 Action Hides showed dialog.
5505  Counterpart to LFUN_DIALOG_SHOW .
5506 \end_layout
5507
5508 \begin_layout Description
5509 Syntax dialog-hide <NAME>
5510 \end_layout
5511
5512 \begin_layout Description
5513 Params See LFUN_DIALOG_SHOW .
5514 \end_layout
5515
5516 \begin_layout Description
5517 Origin leeming, 25 Feb 2003
5518 \end_layout
5519
5520 \begin_layout Subsection*
5521 LFUN_DIALOG_TOGGLE
5522 \end_layout
5523
5524 \begin_layout Description
5525 Action Toggles dialog between showed/hidden state.
5526 \end_layout
5527
5528 \begin_layout Description
5529 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
5530 \end_layout
5531
5532 \begin_layout Description
5533 Syntax dialog-toggle <NAME> [<DATA>]
5534 \end_layout
5535
5536 \begin_layout Description
5537 Params See LFUN_DIALOG_SHOW .
5538 \end_layout
5539
5540 \begin_layout Description
5541 Origin JSpitzm, 30 Apr 2007
5542 \end_layout
5543
5544 \begin_layout Subsection*
5545 LFUN_DIALOG_DISCONNECT_INSET
5546 \end_layout
5547
5548 \begin_layout Description
5549 Action Closes opened connection to opened inset.
5550 \end_layout
5551
5552 \begin_layout Description
5553 Notion Connection is used for apply functions.
5554 \end_layout
5555
5556 \begin_layout Description
5557 Syntax dialog-disconnect-inset <INSET-NAME>
5558 \end_layout
5559
5560 \begin_layout Description
5561 Origin leeming, 25 Feb 2003
5562 \end_layout
5563
5564 \begin_layout Subsection*
5565 LFUN_MOUSE_PRESS
5566 \end_layout
5567
5568 \begin_layout Description
5569 Action This function is called when mouse button is pressed (inside workarea).
5570  Action depends on the context.
5571 \end_layout
5572
5573 \begin_layout Description
5574 Notion This is an internal LFUN, not to be used by users.
5575 \end_layout
5576
5577 \begin_layout Description
5578 Origin Andre, 9 Aug 2002
5579 \end_layout
5580
5581 \begin_layout Subsection*
5582 LFUN_MOUSE_DOUBLE
5583 \end_layout
5584
5585 \begin_layout Description
5586 Action This function is called when double click on mouse button is pressed
5587  (inside workarea).
5588  Action depends on the context.
5589 \end_layout
5590
5591 \begin_layout Description
5592 Notion This is an internal LFUN, not to be used by users.
5593 \end_layout
5594
5595 \begin_layout Description
5596 Origin Andre, 9 Aug 2002
5597 \end_layout
5598
5599 \begin_layout Subsection*
5600 LFUN_MOUSE_TRIPLE
5601 \end_layout
5602
5603 \begin_layout Description
5604 Action This function is called when triple click on mouse button is pressed
5605  (inside workarea).
5606  Action depends on the context.
5607 \end_layout
5608
5609 \begin_layout Description
5610 Notion This is an internal LFUN, not to be used by users.
5611 \end_layout
5612
5613 \begin_layout Description
5614 Origin Andre, 9 Aug 2002
5615 \end_layout
5616
5617 \begin_layout Subsection*
5618 LFUN_MOUSE_MOTION
5619 \end_layout
5620
5621 \begin_layout Description
5622 Action This function is called when mouse cursor is moving over the text.
5623  Action depends on the context.
5624 \end_layout
5625
5626 \begin_layout Description
5627 Notion This is an internal LFUN, not to be used by users.
5628 \end_layout
5629
5630 \begin_layout Description
5631 Origin Andre, 9 Aug 2002
5632 \end_layout
5633
5634 \begin_layout Subsection*
5635 LFUN_MOUSE_RELEASE
5636 \end_layout
5637
5638 \begin_layout Description
5639 Action This function is called when mouse button is released (inside workarea).
5640  Action depends on the context.
5641 \end_layout
5642
5643 \begin_layout Description
5644 Notion This is an internal LFUN, not to be used by users.
5645 \end_layout
5646
5647 \begin_layout Description
5648 Origin Andre, 9 Aug 2002
5649 \end_layout
5650
5651 \begin_layout Subsection*
5652 LFUN_KEYMAP_OFF
5653 \end_layout
5654
5655 \begin_layout Description
5656 Action Turn off the loaded keyboard map.
5657 \end_layout
5658
5659 \begin_layout Description
5660 Syntax keymap-off
5661 \end_layout
5662
5663 \begin_layout Subsection*
5664 LFUN_KEYMAP_PRIMARY
5665 \end_layout
5666
5667 \begin_layout Description
5668 Action Turn on the primary keyboard map.
5669 \end_layout
5670
5671 \begin_layout Description
5672 Notion Maps were widely used in past, when X-windows didn't have nowadays
5673  keyboard support.
5674  They can be still used to maintain uniform keyboard layout across the various
5675  platforms.
5676 \begin_inset Newline newline
5677 \end_inset
5678
5679 The language is to be set in the Preferences dialog.
5680 \end_layout
5681
5682 \begin_layout Description
5683 Syntax keymap-primary
5684 \end_layout
5685
5686 \begin_layout Subsection*
5687 LFUN_KEYMAP_SECONDARY
5688 \end_layout
5689
5690 \begin_layout Description
5691 Action Turn on the secondary keyboard map.
5692 \end_layout
5693
5694 \begin_layout Description
5695 Syntax keymap-secondary
5696 \end_layout
5697
5698 \begin_layout Subsection*
5699 LFUN_KEYMAP_TOGGLE
5700 \end_layout
5701
5702 \begin_layout Description
5703 Action Toggles keyboard maps (first/second/off).
5704 \end_layout
5705
5706 \begin_layout Description
5707 Syntax keymap-toggle
5708 \end_layout
5709
5710 \begin_layout Description
5711 Origin leeming, 30 Mar 2004
5712 \end_layout
5713
5714 \begin_layout Subsection*
5715 LFUN_SERVER_GET_LAYOUT
5716 \end_layout
5717
5718 \begin_layout Description
5719 Action Returns the current layout (that is environment) name on the cursor
5720  position.
5721 \end_layout
5722
5723 \begin_layout Description
5724 Syntax server-get-layout
5725 \end_layout
5726
5727 \begin_layout Subsection*
5728 LFUN_SERVER_GET_FILENAME
5729 \end_layout
5730
5731 \begin_layout Description
5732 Action Returns path and file name of the currently edited document.
5733 \end_layout
5734
5735 \begin_layout Description
5736 Syntax server-get-filename
5737 \end_layout
5738
5739 \begin_layout Subsection*
5740 LFUN_SERVER_GOTO_FILE_ROW
5741 \end_layout
5742
5743 \begin_layout Description
5744 Action Sets the cursor position in LyX based on the row number of generated
5745  TeX file.
5746 \end_layout
5747
5748 \begin_layout Description
5749 Notion This can be useful for DVI inverse-search or detection of the problematic
5750  line from LaTeX compilation.
5751  Note that before this function can be used export to LaTeX output must
5752  occur (in order to map the row numbers).
5753 \end_layout
5754
5755 \begin_layout Description
5756 Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
5757 \end_layout
5758
5759 \begin_layout Description
5760 Params <FILE>: the path and filename.
5761  Environment variables are expanded in the path.
5762  In case this LFUN does not work make sure you are giving correct path to
5763  the file.
5764 \begin_inset Newline newline
5765 \end_inset
5766
5767 If the file is located inside LyX temporary directory it will be mapped
5768  back into the appropriate opened buffer (e.g.
5769  for the case of generated .tex file).
5770 \begin_inset Newline newline
5771 \end_inset
5772
5773 .ext: extensions will be automatically replaced by .lyx.
5774 \begin_inset Newline newline
5775 \end_inset
5776
5777 <ROW_NUMBER> The row number of the LaTeX file to which to go.
5778 \end_layout
5779
5780 \begin_layout Description
5781 Sample server-goto-file-row /home/user/example.lyx 41
5782 \begin_inset Newline newline
5783 \end_inset
5784
5785 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
5786 \end_layout
5787
5788 \begin_layout Description
5789 Origin Edmar, 23 Dec 1998
5790 \end_layout
5791
5792 \begin_layout Subsection*
5793 LFUN_FORWARD_SEARCH
5794 \end_layout
5795
5796 \begin_layout Description
5797 Action Sets the cursor position in the previewed (dvi/pdf) file based on
5798  the row number in LyX window.
5799 \end_layout
5800
5801 \begin_layout Description
5802 Notion The external program used for forward search call can be specified
5803  in LyX Output preferences.
5804  See Additional manual for details of these            settings.
5805 \end_layout
5806
5807 \begin_layout Description
5808 Syntax forward-search
5809 \end_layout
5810
5811 \begin_layout Description
5812 Origin sanda, 14 Apr 2010
5813 \end_layout
5814
5815 \begin_layout Subsection*
5816 LFUN_SERVER_NOTIFY
5817 \end_layout
5818
5819 \begin_layout Description
5820 Action Sends notify message about the last key-sequence to client.
5821 \end_layout
5822
5823 \begin_layout Description
5824 Notion This can be used to grab last key-sequence used inside the LyX window.
5825  See also Debug extensions section in Additional features manual.
5826 \end_layout
5827
5828 \begin_layout Description
5829 Syntax server-notify
5830 \end_layout
5831
5832 \begin_layout Subsection*
5833 LFUN_SERVER_SET_XY
5834 \end_layout
5835
5836 \begin_layout Description
5837 Action Sets the cursor position based on the editing area coordinates (similar
5838  to clicking on that point with left mouse button).
5839 \end_layout
5840
5841 \begin_layout Description
5842 Syntax server-set-xy <X> <Y>
5843 \end_layout
5844
5845 \begin_layout Subsection*
5846 LFUN_SERVER_GET_XY
5847 \end_layout
5848
5849 \begin_layout Description
5850 Action Returns the coordinates of cursor position in the editing area.
5851 \end_layout
5852
5853 \begin_layout Description
5854 Syntax server-get-xy
5855 \end_layout
5856
5857 \begin_layout Subsection*
5858 LFUN_BUILD_PROGRAM
5859 \end_layout
5860
5861 \begin_layout Description
5862 Action Generates the code (literate programming).
5863 \end_layout
5864
5865 \begin_layout Description
5866 Notion Latex file with extension
5867 \backslash
5868 literate_extension is generated.
5869  Then LyX invokes
5870 \backslash
5871 build_command (with a default of ``make'') to generate the code and
5872 \backslash
5873 build_error_filter to process the compilation error messages.
5874 \begin_inset Newline newline
5875 \end_inset
5876
5877 In case you want to process your literate file with a script, or some other
5878  program, just insert in your lyxrc file an entry with:
5879 \begin_inset Newline newline
5880 \end_inset
5881
5882
5883 \backslash
5884 build_command "my_script my_arguments"
5885 \begin_inset Newline newline
5886 \end_inset
5887
5888 The
5889 \backslash
5890 build_error_filter differs from the
5891 \backslash
5892 literate_error_filter only in that the former will identify error messages
5893  from your compiler.
5894 \end_layout
5895
5896 \begin_layout Description
5897 Syntax build-program
5898 \end_layout
5899
5900 \begin_layout Subsection*
5901 LFUN_BUFFER_AUTO_SAVE
5902 \end_layout
5903
5904 \begin_layout Description
5905 Action Saves the current buffer to a temporary file.
5906 \end_layout
5907
5908 \begin_layout Description
5909 Notion Saves the current buffer to a file named "#filename#".
5910  This LFUN is called automatically by LyX, to "autosave" the current buffer.
5911 \end_layout
5912
5913 \begin_layout Description
5914 Syntax buffer-auto-save
5915 \end_layout
5916
5917 \begin_layout Subsection*
5918 LFUN_BUFFER_CHILD_OPEN
5919 \end_layout
5920
5921 \begin_layout Description
5922 Action Loads the given child document.
5923 \end_layout
5924
5925 \begin_layout Description
5926 Notion The current document is treated as a parent.
5927 \end_layout
5928
5929 \begin_layout Description
5930 Syntax buffer-child-open <FILE>
5931 \end_layout
5932
5933 \begin_layout Description
5934 Params <FILE>: Filename of the child.
5935  The directory of the parent is assumed by default.
5936 \end_layout
5937
5938 \begin_layout Description
5939 Origin Ale, 28 May 1997
5940 \end_layout
5941
5942 \begin_layout Subsection*
5943 LFUN_BUFFER_CHKTEX
5944 \end_layout
5945
5946 \begin_layout Description
5947 Action Runs chktex for the current document.
5948 \end_layout
5949
5950 \begin_layout Description
5951 Syntax buffer-chktex
5952 \end_layout
5953
5954 \begin_layout Description
5955 Origin Asger, 30 Oct 1997
5956 \end_layout
5957
5958 \begin_layout Subsection*
5959 LFUN_BUFFER_TOGGLE_COMPRESSION
5960 \end_layout
5961
5962 \begin_layout Description
5963 Action Toggles compression of the current document on/off.
5964 \end_layout
5965
5966 \begin_layout Description
5967 Syntax buffer-toggle-compression
5968 \end_layout
5969
5970 \begin_layout Description
5971 Origin bpeng, 27 Apr 2006
5972 \end_layout
5973
5974 \begin_layout Subsection*
5975 LFUN_BUFFER_TOGGLE_OUTPUT_SYNC
5976 \end_layout
5977
5978 \begin_layout Description
5979 Action Toggles including of resources for forward/reverse search of the
5980  given document.
5981 \end_layout
5982
5983 \begin_layout Description
5984 Notion When toggled on, SyncTeX is invoked for PDF, while srcltx package
5985  is used for DVI.
5986  Custom LaTeX macro can be defined in preferences.
5987 \end_layout
5988
5989 \begin_layout Description
5990 Syntax buffer-toggle-output-sync
5991 \end_layout
5992
5993 \begin_layout Description
5994 Origin sanda, 25 May 2010
5995 \end_layout
5996
5997 \begin_layout Subsection*
5998 LFUN_BUFFER_CLOSE
5999 \end_layout
6000
6001 \begin_layout Description
6002 Action Closes the current buffer.
6003 \end_layout
6004
6005 \begin_layout Description
6006 Notion Closes the current buffer, asking whether to save it, etc, if the
6007  buffer has been modified.
6008 \end_layout
6009
6010 \begin_layout Description
6011 Syntax buffer-close
6012 \end_layout
6013
6014 \begin_layout Subsection*
6015 LFUN_BUFFER_CLOSE_ALL
6016 \end_layout
6017
6018 \begin_layout Description
6019 Action Closes all buffers.
6020 \end_layout
6021
6022 \begin_layout Description
6023 Notion Closes all buffers, asking whether to save it, etc, if a buffer has
6024  been modified.
6025 \end_layout
6026
6027 \begin_layout Description
6028 Syntax buffer-close-all
6029 \end_layout
6030
6031 \begin_layout Subsection*
6032 LFUN_BUFFER_EXPORT
6033 \end_layout
6034
6035 \begin_layout Description
6036 Action Exports the current buffer (document) to the given format.
6037 \end_layout
6038
6039 \begin_layout Description
6040 Syntax buffer-export <FORMAT> [<DEST>]
6041 \end_layout
6042
6043 \begin_layout Description
6044 Params <FORMAT> is either "custom" or one of the formats which you can find
6045  in Tools->Preferences->File formats->Format.
6046  Usual format you will enter is "pdf2" (pdflatex), "pdflatex" (plain tex
6047  for pdflatex) or "ps" for postscript.
6048 \begin_inset Newline newline
6049 \end_inset
6050
6051 In case of "custom" you will be asked for a format you want to start from
6052  and for the command that you want to apply to this format.
6053  Internally the control is then passed to LFUN_BUFFER_EXPORT_CUSTOM.
6054                 <DEST>  If present, this argument provides the export destination                       filename.
6055  Its containing folder will also be the destination                     folder, where all
6056  the needed external files will be copied.
6057 \end_layout
6058
6059 \begin_layout Description
6060 Origin Lgb, 29 Jul 1997
6061 \end_layout
6062
6063 \begin_layout Subsection*
6064 LFUN_BUFFER_EXPORT_CUSTOM
6065 \end_layout
6066
6067 \begin_layout Description
6068 Action Exports the current buffer (document) from the given format using
6069  the given command on it.
6070 \end_layout
6071
6072 \begin_layout Description
6073 Syntax buffer-export-custom <FORMAT> <COMMAND>
6074 \end_layout
6075
6076 \begin_layout Description
6077 Params <FORMAT> format to start from (LyX will care to produce such intermediate
6078  file).
6079 \begin_inset Newline newline
6080 \end_inset
6081
6082 <COMMAND> this command will be launched on the file.
6083  Note that you can use "$$FName" string to qualify the intermediate file.
6084 \end_layout
6085
6086 \begin_layout Description
6087 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
6088 \end_layout
6089
6090 \begin_layout Description
6091 Origin leeming, 27 Mar 2004
6092 \end_layout
6093
6094 \begin_layout Subsection*
6095 LFUN_BUFFER_EXPORT_AS
6096 \end_layout
6097
6098 \begin_layout Description
6099 Action Pops up a dialog for exporting the current buffer.
6100 \end_layout
6101
6102 \begin_layout Description
6103 Syntax buffer-export-as
6104 \end_layout
6105
6106 \begin_layout Description
6107 Origin tommaso, 6 Oct 2011
6108 \end_layout
6109
6110 \begin_layout Subsection*
6111 LFUN_BUFFER_PRINT
6112 \end_layout
6113
6114 \begin_layout Description
6115 Action Prints the current document.
6116 \end_layout
6117
6118 \begin_layout Description
6119 Notion Many settings can be given via the preferences dialog.
6120 \end_layout
6121
6122 \begin_layout Description
6123 Syntax buffer-print <TARGET> <TARGET-NAME> <COMMAND>
6124 \end_layout
6125
6126 \begin_layout Description
6127 Params <TARGET> is either "printer" or "file".
6128 \begin_inset Newline newline
6129 \end_inset
6130
6131 <TARGER-NAME> is either "default" or file name or printer name.
6132 \begin_inset Newline newline
6133 \end_inset
6134
6135 <COMMAND> command ensuring the printing job.
6136 \end_layout
6137
6138 \begin_layout Description
6139 Sample buffer-print file "/trash/newfile1.ps" "dvips"
6140 \end_layout
6141
6142 \begin_layout Description
6143 Origin leeming, 28 Mar 2004
6144 \end_layout
6145
6146 \begin_layout Subsection*
6147 LFUN_BUFFER_IMPORT
6148 \end_layout
6149
6150 \begin_layout Description
6151 Action Import a given file as a lyx document.
6152 \end_layout
6153
6154 \begin_layout Description
6155 Notion File can be imported iff lyx file format is (transitively) reachable
6156  via defined converters in preferences.
6157  Look in the File->Import menu to get an idea of the currently active import
6158  formats.
6159 \end_layout
6160
6161 \begin_layout Description
6162 Syntax buffer-import <FORMAT> [<FILE>]
6163 \end_layout
6164
6165 \begin_layout Description
6166 Origin Asger, 24 Jul 1998
6167 \end_layout
6168
6169 \begin_layout Subsection*
6170 LFUN_BUFFER_NEW
6171 \end_layout
6172
6173 \begin_layout Description
6174 Action Creates a new buffer (that is, document) and switches to it.
6175 \end_layout
6176
6177 \begin_layout Description
6178 Notion Implicit path can be set in Preferences dialog.
6179 \end_layout
6180
6181 \begin_layout Description
6182 Syntax buffer-new [<FILE>]
6183 \end_layout
6184
6185 \begin_layout Description
6186 Params <FILE>: filename of created file with absolute path.
6187 \end_layout
6188
6189 \begin_layout Subsection*
6190 LFUN_BUFFER_NEW_TEMPLATE
6191 \end_layout
6192
6193 \begin_layout Description
6194 Action Creates a new buffer (that is, document) from a template.
6195 \end_layout
6196
6197 \begin_layout Description
6198 Notion Path for new files and templates can be set in Preferences dialog.
6199  Template will be asked for via Open-dialog.
6200 \end_layout
6201
6202 \begin_layout Description
6203 Syntax buffer-new-template [<FILE>]
6204 \end_layout
6205
6206 \begin_layout Description
6207 Params <FILE>: filename of created file with absolute path.
6208 \end_layout
6209
6210 \begin_layout Subsection*
6211 LFUN_BUFFER_RELOAD
6212 \end_layout
6213
6214 \begin_layout Description
6215 Action Reverts opened document.
6216 \end_layout
6217
6218 \begin_layout Description
6219 Syntax buffer-reload
6220 \end_layout
6221
6222 \begin_layout Description
6223 Origin Asger, 2 Feb 1997
6224 \end_layout
6225
6226 \begin_layout Subsection*
6227 LFUN_BUFFER_SWITCH
6228 \end_layout
6229
6230 \begin_layout Description
6231 Action Display and switch to the given buffer.
6232 \end_layout
6233
6234 \begin_layout Description
6235 Syntax buffer-switch <BUFFER>
6236 \end_layout
6237
6238 \begin_layout Description
6239 Params <BUFFER>: path and filename of already opened (but possibly hidden)
6240  document which is to be shown.
6241 \end_layout
6242
6243 \begin_layout Subsection*
6244 LFUN_BUFFER_TOGGLE_READ_ONLY
6245 \end_layout
6246
6247 \begin_layout Description
6248 Action Toggle editing mode of the current document between read/write and
6249  read-only.
6250 \end_layout
6251
6252 \begin_layout Description
6253 Notion This function is not allowed if the file is under version control,
6254  since read-only flag is often used in version control file locking.
6255 \end_layout
6256
6257 \begin_layout Description
6258 Syntax buffer-toggle-read-only
6259 \end_layout
6260
6261 \begin_layout Description
6262 Origin Lgb, 27 May 1997
6263 \end_layout
6264
6265 \begin_layout Subsection*
6266 LFUN_BUFFER_VIEW
6267 \end_layout
6268
6269 \begin_layout Description
6270 Action Displays current buffer in chosen format.
6271 \end_layout
6272
6273 \begin_layout Description
6274 Notion Displays the contents of the current buffer in the chosen format,
6275  for example, PDF or DVI.
6276  This runs the necessary converter, calls the defined viewer, and so forth.
6277 \end_layout
6278
6279 \begin_layout Description
6280 Syntax buffer-view [<FORMAT>]
6281 \end_layout
6282
6283 \begin_layout Description
6284 Params <FORMAT>: The format to display, where this is one of the formats
6285  defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
6286  If no format is given, the default format as specified in the same dialog
6287  is used.
6288 \end_layout
6289
6290 \begin_layout Subsection*
6291 LFUN_BUFFER_UPDATE
6292 \end_layout
6293
6294 \begin_layout Description
6295 Action Exports the current document and put the result into the temporary
6296  directory.
6297 \end_layout
6298
6299 \begin_layout Description
6300 Notion In case you are already viewing the exported document (see LFUN_BUFFER_VI
6301 EW) the output will be rewritten - updated.
6302  This is useful in case your viewer is able to detect such changes (e.g.
6303  ghostview for postscript).
6304 \end_layout
6305
6306 \begin_layout Description
6307 Syntax buffer-update [<FORMAT>]
6308 \end_layout
6309
6310 \begin_layout Description
6311 Params <FORMAT>: The format to display, where this is one of the formats
6312  defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
6313  If no format is given, the default format as specified in the same dialog
6314  is used.
6315 \end_layout
6316
6317 \begin_layout Description
6318 Origin Dekel, 5 Aug 2000
6319 \end_layout
6320
6321 \begin_layout Subsection*
6322 LFUN_BUFFER_WRITE
6323 \end_layout
6324
6325 \begin_layout Description
6326 Action Saves the current buffer.
6327 \end_layout
6328
6329 \begin_layout Description
6330 Notion Saves the current buffer to disk, using the filename that is already
6331  associated with the buffer, asking for one if none is yet assigned.
6332 \end_layout
6333
6334 \begin_layout Description
6335 Syntax buffer-write
6336 \end_layout
6337
6338 \begin_layout Subsection*
6339 LFUN_BUFFER_WRITE_AS
6340 \end_layout
6341
6342 \begin_layout Description
6343 Action Rename and save current buffer.
6344 \end_layout
6345
6346 \begin_layout Description
6347 Syntax buffer-write-as <FILENAME>
6348 \end_layout
6349
6350 \begin_layout Description
6351 Params <FILENAME>: New name of the buffer/file.
6352  A relative path is with respect to the original location of the buffer/file.
6353 \end_layout
6354
6355 \begin_layout Subsection*
6356 LFUN_BUFFER_FORALL
6357 \end_layout
6358
6359 \begin_layout Description
6360 Action Applies a command to all non-hidden buffers.
6361 \end_layout
6362
6363 \begin_layout Description
6364 Notion a buffer is `hidden' if it is internally open in LyX, but not visible
6365  in any window.
6366 \end_layout
6367
6368 \begin_layout Description
6369 Syntax buffer-forall <LFUN-COMMAND>
6370 \end_layout
6371
6372 \begin_layout Description
6373 Params <LFUN-COMMAND>: The command to be applied to the buffers.
6374 \end_layout
6375
6376 \begin_layout Description
6377 Sample Close all Notes in buffers:
6378 \begin_inset Newline newline
6379 \end_inset
6380
6381                    buffer-forall inset-forall Note inset-toggle close
6382 \begin_inset Newline newline
6383 \end_inset
6384
6385 Toggle change tracking on buffers:
6386 \begin_inset Newline newline
6387 \end_inset
6388
6389                    buffer-forall changes-track
6390 \begin_inset Newline newline
6391 \end_inset
6392
6393 Toggle read-only for buffers:
6394 \begin_inset Newline newline
6395 \end_inset
6396
6397                    buffer-forall buffer-toggle-read-only
6398 \begin_inset Newline newline
6399 \end_inset
6400
6401 Show statistics for individual buffers:
6402 \begin_inset Newline newline
6403 \end_inset
6404
6405                    buffer-forall statistics
6406 \begin_inset Newline newline
6407 \end_inset
6408
6409 Activate the branch named "Solutions" in buffers:
6410 \begin_inset Newline newline
6411 \end_inset
6412
6413                    buffer-forall branch-activate Solutions
6414 \begin_inset Newline newline
6415 \end_inset
6416
6417 Export buffers to PDF (pdflatex):
6418 \begin_inset Newline newline
6419 \end_inset
6420
6421                    buffer-forall buffer-export pdf2
6422 \begin_inset Newline newline
6423 \end_inset
6424
6425
6426 \end_layout
6427
6428 \begin_layout Description
6429 Origin scottkostyshak, 20 Jul 2012
6430 \end_layout
6431
6432 \begin_layout Subsection*
6433 LFUN_BUFFER_WRITE_ALL
6434 \end_layout
6435
6436 \begin_layout Description
6437 Action Save all changed documents.
6438 \end_layout
6439
6440 \begin_layout Description
6441 Syntax buffer-write-all
6442 \end_layout
6443
6444 \begin_layout Description
6445 Origin rgh, gpothier 6 Aug 2007
6446 \end_layout
6447
6448 \begin_layout Subsection*
6449 LFUN_BUFFER_NEXT
6450 \end_layout
6451
6452 \begin_layout Description
6453 Action Switch to the next opened document.
6454 \end_layout
6455
6456 \begin_layout Description
6457 Notion Note that this does not necessarily mean next in tabbar (for full
6458  list see View menu).
6459 \end_layout
6460
6461 \begin_layout Description
6462 Syntax buffer-next
6463 \end_layout
6464
6465 \begin_layout Subsection*
6466 LFUN_BUFFER_PREVIOUS
6467 \end_layout
6468
6469 \begin_layout Description
6470 Action Switch to the previous opened document.
6471 \end_layout
6472
6473 \begin_layout Description
6474 Syntax buffer-previous
6475 \end_layout
6476
6477 \begin_layout Subsection*
6478 LFUN_MASTER_BUFFER_UPDATE
6479 \end_layout
6480
6481 \begin_layout Description
6482 Action When run from a child document, this updates (exports) document built
6483  from the master buffer, if available.
6484 \end_layout
6485
6486 \begin_layout Description
6487 Syntax master-buffer-update [<FORMAT>]
6488 \end_layout
6489
6490 \begin_layout Description
6491 Params <FORMAT>: The format to display, where this is one of the formats
6492  defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
6493  If no format is given, the default format as specified in the same dialog
6494  is used.
6495 \end_layout
6496
6497 \begin_layout Description
6498 Origin Tommaso, 20 Sep 2007
6499 \end_layout
6500
6501 \begin_layout Subsection*
6502 LFUN_MASTER_BUFFER_VIEW
6503 \end_layout
6504
6505 \begin_layout Description
6506 Action When run from a child document, this command shows a preview built
6507  from the master buffer, if available.
6508 \end_layout
6509
6510 \begin_layout Description
6511 Syntax master-buffer-view [<FORMAT>]
6512 \end_layout
6513
6514 \begin_layout Description
6515 Params <FORMAT>: The format to display, where this is one of the formats
6516  defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
6517  If no format is given, the default format as specified in the same dialog
6518  is used.
6519 \end_layout
6520
6521 \begin_layout Description
6522 Origin Tommaso, 20 Sep 2007
6523 \end_layout
6524
6525 \begin_layout Subsection*
6526 LFUN_BUFFER_LANGUAGE
6527 \end_layout
6528
6529 \begin_layout Description
6530 Action Set language of the current document.
6531 \end_layout
6532
6533 \begin_layout Description
6534 Syntax buffer-language <LANG>
6535 \end_layout
6536
6537 \begin_layout Description
6538 Params <LANG>: language name.
6539  See lib/languages for list.
6540 \end_layout
6541
6542 \begin_layout Description
6543 Origin leeming, 30 Mar 2004
6544 \end_layout
6545
6546 \begin_layout Subsection*
6547 LFUN_BUFFER_SAVE_AS_DEFAULT
6548 \end_layout
6549
6550 \begin_layout Description
6551 Action Save the current document settings as default.
6552 \end_layout
6553
6554 \begin_layout Description
6555 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
6556 \end_layout
6557
6558 \begin_layout Description
6559 Syntax buffer-save-as-default [<ARGS>]
6560 \end_layout
6561
6562 \begin_layout Description
6563 Params <ARGS>: contains the particular settings to be saved.
6564  They obey the syntax you can find in document header of usual .lyx file.
6565 \end_layout
6566
6567 \begin_layout Description
6568 Origin leeming, 30 Mar 2004
6569 \end_layout
6570
6571 \begin_layout Subsection*
6572 LFUN_BUFFER_PARAMS_APPLY
6573 \end_layout
6574
6575 \begin_layout Description
6576 Action Apply the given settings to the current document.
6577 \end_layout
6578
6579 \begin_layout Description
6580 Syntax buffer-params-apply [<ARGS>]
6581 \end_layout
6582
6583 \begin_layout Description
6584 Params <ARGS>: contains the particular settings to be saved.
6585  They obey the syntax you can find in document header of usual .lyx file.
6586 \end_layout
6587
6588 \begin_layout Description
6589 Origin leeming, 30 Mar 2004
6590 \end_layout
6591
6592 \begin_layout Subsection*
6593 LFUN_FILE_INSERT
6594 \end_layout
6595
6596 \begin_layout Description
6597 Action Inserts another LyX file.
6598 \end_layout
6599
6600 \begin_layout Description
6601 Syntax file-insert [<FILE>]
6602 \end_layout
6603
6604 \begin_layout Description
6605 Params <FILE>: Filename to be inserted.
6606 \end_layout
6607
6608 \begin_layout Subsection*
6609 LFUN_FILE_INSERT_PLAINTEXT
6610 \end_layout
6611
6612 \begin_layout Description
6613 Action Inserts plain text file.
6614 \end_layout
6615
6616 \begin_layout Description
6617 Syntax file-insert-plaintext [<FILE>]
6618 \end_layout
6619
6620 \begin_layout Description
6621 Params <FILE>: Filename to be inserted.
6622 \end_layout
6623
6624 \begin_layout Description
6625 Origin CFO-G, 19 Nov 1997
6626 \end_layout
6627
6628 \begin_layout Subsection*
6629 LFUN_FILE_INSERT_PLAINTEXT_PARA
6630 \end_layout
6631
6632 \begin_layout Description
6633 Action Inserts plain text file as paragraph (i.e.
6634  join lines).
6635 \end_layout
6636
6637 \begin_layout Description
6638 Syntax file-insert-plaintext-para [<FILE>]
6639 \end_layout
6640
6641 \begin_layout Description
6642 Params <FILE>: Filename to be inserted.
6643 \end_layout
6644
6645 \begin_layout Description
6646 Origin Levon, 14 Feb 2001
6647 \end_layout
6648
6649 \begin_layout Subsection*
6650 LFUN_FILE_OPEN
6651 \end_layout
6652
6653 \begin_layout Description
6654 Action Open LyX document.
6655 \end_layout
6656
6657 \begin_layout Description
6658 Syntax file-open [<FILE>]
6659 \end_layout
6660
6661 \begin_layout Description
6662 Params <FILE>: Filename to be opened.
6663 \end_layout
6664
6665 \begin_layout Subsection*
6666 LFUN_CALL
6667 \end_layout
6668
6669 \begin_layout Description
6670 Action Executes a command defined in a .def file.
6671 \end_layout
6672
6673 \begin_layout Description
6674 Notion The definitions are by default read from lib/commands/default.def.
6675 \begin_inset Newline newline
6676 \end_inset
6677
6678 A .def file allows to define a command with
6679 \backslash
6680 define "<NAME>" "<LFUN>" where <NAME> is the name of the new command and
6681  <LFUN> is the lfun code to be executed (see e.g.
6682  LFUN_COMMAND_SEQUENCE).
6683
6684 \backslash
6685 def_file "FileName" allows to include another .def file.
6686 \begin_inset Newline newline
6687 \end_inset
6688
6689 This is particularly useful in connection with toolbar buttons: Since the
6690  name of the button image for this lfun is lib/images/commands/<NAME>.png
6691  this is the way to assign an image to a complex command-sequence.
6692 \end_layout
6693
6694 \begin_layout Description
6695 Syntax call <NAME>
6696 \end_layout
6697
6698 \begin_layout Description
6699 Params <NAME>: Name of the command that must be called.
6700 \end_layout
6701
6702 \begin_layout Description
6703 Origin broider, 2 Oct 2007
6704 \end_layout
6705
6706 \begin_layout Subsection*
6707 LFUN_META_PREFIX
6708 \end_layout
6709
6710 \begin_layout Description
6711 Action Simulate halting Meta key (Alt key on PCs).
6712 \end_layout
6713
6714 \begin_layout Description
6715 Notion Used for buffer editation not for GUI control.
6716 \end_layout
6717
6718 \begin_layout Description
6719 Syntax meta-prefix
6720 \end_layout
6721
6722 \begin_layout Subsection*
6723 LFUN_CANCEL
6724 \end_layout
6725
6726 \begin_layout Description
6727 Action Cancels sequence prepared by LFUN_META_PREFIX .
6728 \end_layout
6729
6730 \begin_layout Description
6731 Syntax cancel
6732 \end_layout
6733
6734 \begin_layout Subsection*
6735 LFUN_COMMAND_EXECUTE
6736 \end_layout
6737
6738 \begin_layout Description
6739 Action Switches the focus to the minibuffer so that the user can type in
6740  there.
6741  If necessary, it opens the minibuffer toolbar.
6742 \end_layout
6743
6744 \begin_layout Description
6745 Notion Usually bound to M-x shortcut.
6746 \end_layout
6747
6748 \begin_layout Description
6749 Syntax command-execute
6750 \end_layout
6751
6752 \begin_layout Subsection*
6753 LFUN_COMMAND_PREFIX
6754 \end_layout
6755
6756 \begin_layout Description
6757 Action Return the current key sequence and available options as a string.
6758 \end_layout
6759
6760 \begin_layout Description
6761 Notion No options are added if no current map exists.
6762 \begin_inset Newline newline
6763 \end_inset
6764
6765 This is probably usable only with connection to lyxserver.
6766 \end_layout
6767
6768 \begin_layout Description
6769 Syntax command-prefix
6770 \end_layout
6771
6772 \begin_layout Subsection*
6773 LFUN_COMMAND_SEQUENCE
6774 \end_layout
6775
6776 \begin_layout Description
6777 Action Run more commands (LFUN and its parameters) in a sequence.
6778 \end_layout
6779
6780 \begin_layout Description
6781 Syntax command-sequence <CMDS>
6782 \end_layout
6783
6784 \begin_layout Description
6785 Params <CMDS>: Sequence of commands separated by semicolons.
6786 \end_layout
6787
6788 \begin_layout Description
6789 Sample command-sequence cut; ert-insert; self-insert
6790 \backslash
6791 ; paste; self-insert {}; inset-toggle;
6792 \end_layout
6793
6794 \begin_layout Description
6795 Origin Andre, 11 Nov 1999
6796 \end_layout
6797
6798 \begin_layout Subsection*
6799 LFUN_COMMAND_ALTERNATIVES
6800 \end_layout
6801
6802 \begin_layout Description
6803 Action Runs the first listed command that is enabled.
6804 \end_layout
6805
6806 \begin_layout Description
6807 Notion This can be used to bind multiple functions to a single key, and
6808  then which one is used will depend upon the context.
6809 \end_layout
6810
6811 \begin_layout Description
6812 Syntax command-alternatives <CMDS>
6813 \end_layout
6814
6815 \begin_layout Description
6816 Params <CMDS>: Sequence of commands separated by semicolons.
6817 \end_layout
6818
6819 \begin_layout Description
6820 Sample command-alternatives completion-accept;cell-forward
6821 \end_layout
6822
6823 \begin_layout Description
6824 Origin rgh, 24 September 2008
6825 \end_layout
6826
6827 \begin_layout Subsection*
6828 LFUN_MESSAGE
6829 \end_layout
6830
6831 \begin_layout Description
6832 Action Shows message in statusbar (for script purposes).
6833 \end_layout
6834
6835 \begin_layout Description
6836 Syntax message <STRING>
6837 \end_layout
6838
6839 \begin_layout Description
6840 Origin Lgb, 8 Apr 2001
6841 \end_layout
6842
6843 \begin_layout Subsection*
6844 LFUN_DEBUG_LEVEL_SET
6845 \end_layout
6846
6847 \begin_layout Description
6848 Action Set debug output level.
6849 \end_layout
6850
6851 \begin_layout Description
6852 Syntax debug-level-set <LEVEL>
6853 \end_layout
6854
6855 \begin_layout Description
6856 Params <LEVEL>: comma separated list of levels or the correspondent number
6857  of their combination.
6858  0 is equivalent to disabling all debug events.
6859  See lyx -dbg for the current list of debug levels and their numbers.
6860 \end_layout
6861
6862 \begin_layout Description
6863 Origin sanda, 28 Dec 2009
6864 \end_layout
6865
6866 \begin_layout Subsection*
6867 LFUN_PREFERENCES_SAVE
6868 \end_layout
6869
6870 \begin_layout Description
6871 Action Save user preferences.
6872 \end_layout
6873
6874 \begin_layout Description
6875 Syntax preferences-save
6876 \end_layout
6877
6878 \begin_layout Description
6879 Origin Lgb, 27 Nov 1999
6880 \end_layout
6881
6882 \begin_layout Subsection*
6883 LFUN_RECONFIGURE
6884 \end_layout
6885
6886 \begin_layout Description
6887 Action Reconfigure the automatic settings.
6888 \end_layout
6889
6890 \begin_layout Description
6891 Syntax reconfigure
6892 \end_layout
6893
6894 \begin_layout Description
6895 Origin Asger, 14 Feb 1997
6896 \end_layout
6897
6898 \begin_layout Subsection*
6899 LFUN_LYXRC_APPLY
6900 \end_layout
6901
6902 \begin_layout Description
6903 Action Apply the given settings to user preferences.
6904 \end_layout
6905
6906 \begin_layout Description
6907 Syntax lyxrc-apply <SETTINGS>
6908 \end_layout
6909
6910 \begin_layout Description
6911 Params <SETTINGS>: settings which are to be set.
6912  Take a look into ~/.lyx/preferences to get an idea which commands to use
6913  and their syntax.
6914  lyx::LyXRC::LyXRCTags has the list of possible commands.
6915 \end_layout
6916
6917 \begin_layout Subsection*
6918 LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
6919 \end_layout
6920
6921 \begin_layout Description
6922 Action Determine whether to keep cursor inside the editing window regardless
6923  of the scrollbar movement.
6924 \end_layout
6925
6926 \begin_layout Description
6927 Syntax toggle-cursor-follows-scrollbar
6928 \end_layout
6929
6930 \begin_layout Description
6931 Origin ARRae, 2 Dec 1997
6932 \end_layout
6933
6934 \begin_layout Subsection*
6935 LFUN_SET_COLOR
6936 \end_layout
6937
6938 \begin_layout Description
6939 Action Set the given LyX color to the color defined by the X11 name given.
6940 \end_layout
6941
6942 \begin_layout Description
6943 Notion A new color entry is created if the color is unknown.
6944  Color names can be stored as a part of user settings.
6945 \end_layout
6946
6947 \begin_layout Description
6948 Syntax set-color <LYX_NAME> <X11_NAME>
6949 \end_layout
6950
6951 \begin_layout Description
6952 Origin SLior, 11 Jun 2000
6953 \end_layout
6954
6955 \begin_layout Subsection*
6956 LFUN_STATISTICS
6957 \end_layout
6958
6959 \begin_layout Description
6960 Action Count the statistics (number of words and characters) in the document
6961  or in the given selection.
6962 \end_layout
6963
6964 \begin_layout Description
6965 Notion Note that this function gives the number of words/chars written,
6966  not the number of characters which will be typeset.
6967 \end_layout
6968
6969 \begin_layout Description
6970 Syntax statistics
6971 \end_layout
6972
6973 \begin_layout Description
6974 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
6975 \end_layout
6976
6977 \begin_layout Subsection*
6978 LFUN_COMPLETION_INLINE
6979 \end_layout
6980
6981 \begin_layout Description
6982 Action Show the inline completion at the cursor position.
6983 \end_layout
6984
6985 \begin_layout Description
6986 Syntax completion-inline
6987 \end_layout
6988
6989 \begin_layout Description
6990 Origin sts, Feb 19 2008
6991 \end_layout
6992
6993 \begin_layout Subsection*
6994 LFUN_COMPLETION_POPUP
6995 \end_layout
6996
6997 \begin_layout Description
6998 Action Show the completion popup at the cursor position.
6999 \end_layout
7000
7001 \begin_layout Description
7002 Syntax completion-popup
7003 \end_layout
7004
7005 \begin_layout Description
7006 Origin sts, Feb 19 2008
7007 \end_layout
7008
7009 \begin_layout Subsection*
7010 LFUN_COMPLETION_COMPLETE
7011 \end_layout
7012
7013 \begin_layout Description
7014 Action Try to complete the word or command at the cursor position.
7015 \end_layout
7016
7017 \begin_layout Description
7018 Syntax complete
7019 \end_layout
7020
7021 \begin_layout Description
7022 Origin sts, Feb 19 2008
7023 \end_layout
7024
7025 \begin_layout Subsection*
7026 LFUN_COMPLETION_CANCEL
7027 \end_layout
7028
7029 \begin_layout Description
7030 Action Try to cancel completion, either the popup or the inline completion.
7031 \end_layout
7032
7033 \begin_layout Description
7034 Syntax completion-cancel
7035 \end_layout
7036
7037 \begin_layout Description
7038 Origin sts, Sep 07 2008
7039 \end_layout
7040
7041 \begin_layout Subsection*
7042 LFUN_COMPLETION_ACCEPT
7043 \end_layout
7044
7045 \begin_layout Description
7046 Action Accept suggested completion.
7047 \end_layout
7048
7049 \begin_layout Description
7050 Syntax completion-accept
7051 \end_layout
7052
7053 \begin_layout Description
7054 Origin sanda, Sep 08 2008
7055 \end_layout
7056
7057 \begin_layout Subsection*
7058 LFUN_BRANCH_ADD
7059 \end_layout
7060
7061 \begin_layout Description
7062 Action Add a branch to the buffer's BranchList.
7063 \end_layout
7064
7065 \begin_layout Description
7066 Syntax branch-add <BRANCH>
7067 \end_layout
7068
7069 \begin_layout Description
7070 Params <BRANCH>: Name of the branch to add
7071 \end_layout
7072
7073 \begin_layout Description
7074 Origin spitz, 7 Jul 2009
7075 \end_layout
7076
7077 \begin_layout Subsection*
7078 LFUN_BRANCH_ACTIVATE
7079 \end_layout
7080
7081 \begin_layout Description
7082 Action Activate the branch.
7083 \end_layout
7084
7085 \begin_layout Description
7086 Syntax branch-activate <BRANCH>
7087 \end_layout
7088
7089 \begin_layout Description
7090 Params <BRANCH>: The branch to activate
7091 \end_layout
7092
7093 \begin_layout Description
7094 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
7095 \begin_inset Newline newline
7096 \end_inset
7097
7098 could be used to export a pdf with the answers branch included without one's
7099  having to open LyX and activate the branch manually.
7100 \end_layout
7101
7102 \begin_layout Description
7103 Origin rgh, 27 May 2008
7104 \end_layout
7105
7106 \begin_layout Subsection*
7107 LFUN_BRANCH_DEACTIVATE
7108 \end_layout
7109
7110 \begin_layout Description
7111 Action De-activate the branch.
7112 \end_layout
7113
7114 \begin_layout Description
7115 Syntax branch-deactivate <BRANCH>
7116 \end_layout
7117
7118 \begin_layout Description
7119 Params <BRANCH>: The branch to deactivate
7120 \end_layout
7121
7122 \begin_layout Description
7123 Origin rgh, 27 May 2008
7124 \end_layout
7125
7126 \begin_layout Subsection*
7127 LFUN_BRANCH_MASTER_ACTIVATE
7128 \end_layout
7129
7130 \begin_layout Description
7131 Action Activate the branch in the master buffer.
7132 \end_layout
7133
7134 \begin_layout Description
7135 Syntax branch-master-activate <BRANCH>
7136 \end_layout
7137
7138 \begin_layout Description
7139 Params <BRANCH>: The branch to activate
7140 \end_layout
7141
7142 \begin_layout Description
7143 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
7144 \begin_inset Newline newline
7145 \end_inset
7146
7147 could be used to export a pdf with the answers branch included without one's
7148  having to open LyX and activate the branch manually.
7149 \end_layout
7150
7151 \begin_layout Description
7152 Origin spitz, 30 Sep 2012
7153 \end_layout
7154
7155 \begin_layout Subsection*
7156 LFUN_BRANCH_MASTER_DEACTIVATE
7157 \end_layout
7158
7159 \begin_layout Description
7160 Action De-activate the branch in the master buffer.
7161 \end_layout
7162
7163 \begin_layout Description
7164 Syntax branch-master-deactivate <BRANCH>
7165 \end_layout
7166
7167 \begin_layout Description
7168 Params <BRANCH>: The branch to deactivate
7169 \end_layout
7170
7171 \begin_layout Description
7172 Origin spitz, 30 Sep 2012
7173 \end_layout
7174
7175 \begin_layout Subsection*
7176 LFUN_BRANCHES_RENAME
7177 \end_layout
7178
7179 \begin_layout Description
7180 Action Rename all branches of a given name in a document.
7181 \end_layout
7182
7183 \begin_layout Description
7184 Syntax branches-rename <OLDNAME> <NEWNAME>
7185 \end_layout
7186
7187 \begin_layout Description
7188 Params <OLDNAME>: Current name of the branch to be renamed <NEWNAME>: New
7189  name of the branch
7190 \end_layout
7191
7192 \begin_layout Description
7193 Origin spitz, 9 Jul 2009
7194 \end_layout
7195
7196 \begin_layout Subsection*
7197 LFUN_BRANCH_ADD_INSERT
7198 \end_layout
7199
7200 \begin_layout Description
7201 Action Create new branch and directly put the branch inset into the document.
7202 \end_layout
7203
7204 \begin_layout Description
7205 Syntax branch-add-insert [<NAME>]
7206 \end_layout
7207
7208 \begin_layout Description
7209 Params <NAME>: Branch name.
7210  If it is not specified, you will be asked.
7211 \end_layout
7212
7213 \begin_layout Description
7214 Origin sanda, 10 Jul 2009
7215 \end_layout
7216
7217 \begin_layout Subsection*
7218 LFUN_LABEL_COPY_AS_REF
7219 \end_layout
7220
7221 \begin_layout Description
7222 Action Copies the label at the cursor as a cross-reference to be pasted
7223  elsewhere.
7224 \end_layout
7225
7226 \begin_layout Description
7227 Syntax copy-label-as-reference <LABEL>
7228 \end_layout
7229
7230 \begin_layout Description
7231 Params <LABEL>: The label to copy (for multi-line math)
7232 \end_layout
7233
7234 \begin_layout Description
7235 Origin sts, 16 Nov 2008
7236 \end_layout
7237
7238 \begin_layout Subsection*
7239 LFUN_LABEL_INSERT_AS_REF
7240 \end_layout
7241
7242 \begin_layout Description
7243 Action Inserts the label (in ToC pane) as a cross-reference at the position
7244  of the cursor.
7245 \end_layout
7246
7247 \begin_layout Description
7248 Syntax label-insert-as-reference
7249 \end_layout
7250
7251 \begin_layout Description
7252 Origin vfr, 7 Apr 2009
7253 \end_layout
7254
7255 \begin_layout Subsection*
7256 LFUN_BUFFER_ZOOM_IN
7257 \end_layout
7258
7259 \begin_layout Description
7260 Action Increases the zoom of the screen fonts.
7261 \end_layout
7262
7263 \begin_layout Description
7264 Syntax buffer-zoom-in [<ZOOM>]
7265 \end_layout
7266
7267 \begin_layout Description
7268 Params <ZOOM>: The zoom in %, the default is 20.
7269 \end_layout
7270
7271 \begin_layout Description
7272 Origin vfr, 30 Mar 2009
7273 \end_layout
7274
7275 \begin_layout Subsection*
7276 LFUN_BUFFER_ZOOM_OUT
7277 \end_layout
7278
7279 \begin_layout Description
7280 Action Decreases the zoom of the screen fonts.
7281 \end_layout
7282
7283 \begin_layout Description
7284 Syntax buffer-zoom-out [<ZOOM>]
7285 \end_layout
7286
7287 \begin_layout Description
7288 Params <ZOOM>: The zoom in %, the default is 20.
7289 \end_layout
7290
7291 \begin_layout Description
7292 Origin vfr, 30 Mar 2009
7293 \end_layout
7294
7295 \begin_layout Subsection*
7296 LFUN_INSET_COPY_AS
7297 \end_layout
7298
7299 \begin_layout Description
7300 Action Copies the inset to the clipboard as a certain type.
7301 \end_layout
7302
7303 \begin_layout Description
7304 Notion Currently used only for InsetInfo where its content is copied as
7305  a text.
7306 \end_layout
7307
7308 \begin_layout Description
7309 Syntax inset-copy-as
7310 \end_layout
7311
7312 \begin_layout Description
7313 Origin vfr, 18 Apr 2010
7314 \end_layout
7315
7316 \begin_layout Subsection*
7317 LFUN_ENVIRONMENT_SPLIT
7318 \end_layout
7319
7320 \begin_layout Description
7321 Action Splits the current environment with a Separator.
7322 \end_layout
7323
7324 \begin_layout Description
7325 Syntax environment-split
7326 \end_layout
7327
7328 \begin_layout Description
7329 Origin spitz, 23 Dec 2012
7330 \end_layout
7331
7332 \end_body
7333 \end_document