lib/doc/LFUNs.lyx

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