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