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