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