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 2011-03-04
  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 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 the internal selection text in permanent selection.
1682 \end_layout
1683 \begin_layout Description
1684 Notion Created in order to have middle mouse button pasting correct (bound to command-alternatives selection-paste ; primary-selection-paste paragraph).
1685 \end_layout
1686 \begin_layout Description
1687 Syntax selection-paste
1688 \end_layout
1689 \begin_layout Description
1690 Origin lasgouttes, 14 Jan 2009
1691 \end_layout
1692
1693 \begin_layout Subsection*
1694 LFUN_UNDO
1695 \end_layout
1696 \begin_layout Description
1697 Action Undoes the last edit.
1698 \end_layout
1699 \begin_layout Description
1700 Syntax undo
1701 \end_layout
1702
1703 \begin_layout Subsection*
1704 LFUN_REDO
1705 \end_layout
1706 \begin_layout Description
1707 Action Redoes the last thing undone.
1708 \end_layout
1709 \begin_layout Description
1710 Syntax redo
1711 \end_layout
1712
1713 \begin_layout Subsection*
1714 LFUN_REPEAT
1715 \end_layout
1716 \begin_layout Description
1717 Action Repeat the given command.
1718 \end_layout
1719 \begin_layout Description
1720 Syntax repeat <COUNT> <LFUN-COMMAND>
1721 \end_layout
1722 \begin_layout Description
1723 Origin Andre, 27 Oct 2003
1724 \end_layout
1725
1726 \begin_layout Subsection*
1727 LFUN_CHARS_TRANSPOSE
1728 \end_layout
1729 \begin_layout Description
1730 Action Transposes the character at the cursor with the one before it.
1731 \end_layout
1732 \begin_layout Description
1733 Syntax chars-transpose
1734 \end_layout
1735 \begin_layout Description
1736 Origin Lgb, 25 Apr 2001
1737 \end_layout
1738
1739 \begin_layout Subsection*
1740 LFUN_DEPTH_DECREMENT
1741 \end_layout
1742 \begin_layout Description
1743 Action Decrease the nesting depth of the (selected) paragraph(s) inside lists.
1744 \end_layout
1745 \begin_layout Description
1746 Syntax depth-decrement
1747 \end_layout
1748
1749 \begin_layout Subsection*
1750 LFUN_DEPTH_INCREMENT
1751 \end_layout
1752 \begin_layout Description
1753 Action Increase the nesting depth of the (selected) paragraph(s) inside lists.
1754 \end_layout
1755 \begin_layout Description
1756 Syntax depth-increment
1757 \end_layout
1758
1759 \begin_layout Subsection*
1760 LFUN_FONT_BOLD
1761 \end_layout
1762 \begin_layout Description
1763 Action Toggles the bold font (selection-wise) using mathbf in math.
1764 \end_layout
1765 \begin_layout Description
1766 Syntax font-bold
1767 \end_layout
1768
1769 \begin_layout Subsection*
1770 LFUN_FONT_BOLDSYMBOL
1771 \end_layout
1772 \begin_layout Description
1773 Action Toggles the bold font (selection-wise) using boldsymbol in math.
1774 \end_layout
1775 \begin_layout Description
1776 Syntax font-boldsymbol
1777 \end_layout
1778
1779 \begin_layout Subsection*
1780 LFUN_FONT_TYPEWRITER
1781 \end_layout
1782 \begin_layout Description
1783 Action Toggles the typewriter family font (selection-wise).
1784 \end_layout
1785 \begin_layout Description
1786 Syntax font-typewriter
1787 \end_layout
1788
1789 \begin_layout Subsection*
1790 LFUN_FONT_UNDERLINE
1791 \end_layout
1792 \begin_layout Description
1793 Action Toggles underline in the font (selection-wise).
1794 \end_layout
1795 \begin_layout Description
1796 Syntax font-underline
1797 \end_layout
1798
1799 \begin_layout Subsection*
1800 LFUN_FONT_UULINE
1801 \end_layout
1802 \begin_layout Description
1803 Action Toggles double underline in the font (selection-wise).
1804 \end_layout
1805 \begin_layout Description
1806 Syntax font-underunderline
1807 \end_layout
1808 \begin_layout Description
1809 Origin sanda, 5 May 2009
1810 \end_layout
1811
1812 \begin_layout Subsection*
1813 LFUN_FONT_UWAVE
1814 \end_layout
1815 \begin_layout Description
1816 Action Toggles wavy underline in the font (selection-wise).
1817 \end_layout
1818 \begin_layout Description
1819 Syntax font-underwave
1820 \end_layout
1821 \begin_layout Description
1822 Origin sanda, 5 May 2009
1823 \end_layout
1824
1825 \begin_layout Subsection*
1826 LFUN_FONT_STRIKEOUT
1827 \end_layout
1828 \begin_layout Description
1829 Action Toggles strikeout (strike-through) in the font (selection-wise).
1830 \end_layout
1831 \begin_layout Description
1832 Syntax font-strikeout
1833 \end_layout
1834 \begin_layout Description
1835 Origin sanda, 3 May 2009
1836 \end_layout
1837
1838 \begin_layout Subsection*
1839 LFUN_FONT_EMPH
1840 \end_layout
1841 \begin_layout Description
1842 Action Toggles the emphasis font style (selection-wise).
1843 \end_layout
1844 \begin_layout Description
1845 Syntax font-emph
1846 \end_layout
1847
1848 \begin_layout Subsection*
1849 LFUN_FONT_NOUN
1850 \end_layout
1851 \begin_layout Description
1852 Action Toggles Noun text style font (selection-wise).
1853 \end_layout
1854 \begin_layout Description
1855 Syntax font-noun
1856 \end_layout
1857
1858 \begin_layout Subsection*
1859 LFUN_FONT_ROMAN
1860 \end_layout
1861 \begin_layout Description
1862 Action Toggles Roman family font (selection-wise).
1863 \end_layout
1864 \begin_layout Description
1865 Syntax font-roman
1866 \end_layout
1867
1868 \begin_layout Subsection*
1869 LFUN_FONT_SANS
1870 \end_layout
1871 \begin_layout Description
1872 Action Toggles Sans Serif family font (selection-wise).
1873 \end_layout
1874 \begin_layout Description
1875 Syntax font-sans
1876 \end_layout
1877
1878 \begin_layout Subsection*
1879 LFUN_FONT_FRAK
1880 \end_layout
1881 \begin_layout Description
1882 Action Toggles Fraktur family font (math-mode, selection-wise).
1883 \end_layout
1884 \begin_layout Description
1885 Syntax font-frak
1886 \end_layout
1887 \begin_layout Description
1888 Origin vermeer, 10 Jan 2002
1889 \end_layout
1890
1891 \begin_layout Subsection*
1892 LFUN_FONT_ITAL
1893 \end_layout
1894 \begin_layout Description
1895 Action Toggles Italics font shape (math-mode, selection-wise).
1896 \end_layout
1897 \begin_layout Description
1898 Syntax font-ital
1899 \end_layout
1900 \begin_layout Description
1901 Origin vermeer, 10 Jan 2002
1902 \end_layout
1903
1904 \begin_layout Subsection*
1905 LFUN_FONT_DEFAULT
1906 \end_layout
1907 \begin_layout Description
1908 Action Reverts the settings of the font to the default values (selection-wise).
1909 \end_layout
1910 \begin_layout Description
1911 Syntax font-default
1912 \end_layout
1913
1914 \begin_layout Subsection*
1915 LFUN_FONT_SIZE
1916 \end_layout
1917 \begin_layout Description
1918 Action Sets font size according to lyx format string.
1919 \end_layout
1920 \begin_layout Description
1921 Syntax font-size <SIZE>
1922 \end_layout
1923 \begin_layout Description
1924 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
1925 \begin_inset Newline newline
1926 \end_inset
1927
1928 largest|huge|giant|increase|decrease|default
1929 \end_layout
1930
1931 \begin_layout Subsection*
1932 LFUN_TEXTSTYLE_APPLY
1933 \end_layout
1934 \begin_layout Description
1935 Action Toggle user-defined (=last-time used) text style.
1936 \end_layout
1937 \begin_layout Description
1938 Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically trigerred when using Text Style dialog.
1939 \end_layout
1940 \begin_layout Description
1941 Syntax textstyle-apply
1942 \end_layout
1943 \begin_layout Description
1944 Origin leeming, 12 Mar 2003
1945 \end_layout
1946
1947 \begin_layout Subsection*
1948 LFUN_TEXTSTYLE_UPDATE
1949 \end_layout
1950 \begin_layout Description
1951 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APPLY.
1952 \end_layout
1953 \begin_layout Description
1954 Syntax textstyle-update <FONT_INFO>
1955 \end_layout
1956 \begin_layout Description
1957 Params <FONT_INFO>: specifies font atributes, e.g. family, series, shape, size, emph, noun, underbar, number, color, language, toggleall.
1958 \begin_inset Newline newline
1959 \end_inset
1960
1961 Use lyx -dbg action for exact syntax of text-style dialog parameters.
1962 \end_layout
1963 \begin_layout Description
1964 Origin leeming, 12 Mar 2003
1965 \end_layout
1966
1967 \begin_layout Subsection*
1968 LFUN_SCREEN_FONT_UPDATE
1969 \end_layout
1970 \begin_layout Description
1971 Action Update fonts and its metrics.
1972 \end_layout
1973 \begin_layout Description
1974 Notion Automatically called after zoom, dpi, font names, or norm change.
1975 \end_layout
1976 \begin_layout Description
1977 Syntax screen-font-update
1978 \end_layout
1979 \begin_layout Description
1980 Origin ARRae, 13 Aug 2000
1981 \end_layout
1982
1983 \begin_layout Subsection*
1984 LFUN_FONT_STATE
1985 \end_layout
1986 \begin_layout Description
1987 Action Returns the info about the current font.
1988 \end_layout
1989 \begin_layout Description
1990 Syntax font-state
1991 \end_layout
1992
1993 \begin_layout Subsection*
1994 LFUN_CITATION_INSERT
1995 \end_layout
1996 \begin_layout Description
1997 Action Inserts citation from loaded citation database.
1998 \end_layout
1999 \begin_layout Description
2000 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
2001 \end_layout
2002 \begin_layout Description
2003 Params <KEY>: Citation (shortcut listed in available citations).
2004 \begin_inset Newline newline
2005 \end_inset
2006
2007 <TEXT_BEFORE>: text which should appear before citation.
2008 \end_layout
2009 \begin_layout Description
2010 Origin AAS, 97-02-23
2011 \end_layout
2012
2013 \begin_layout Subsection*
2014 LFUN_BIBTEX_DATABASE_ADD
2015 \end_layout
2016 \begin_layout Description
2017 Action Adds database, which will be used for bibtex citations.
2018 \end_layout
2019 \begin_layout Description
2020 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
2021 \end_layout
2022 \begin_layout Description
2023 Syntax bibtex-database-add <DATABASE-NAME>
2024 \end_layout
2025 \begin_layout Description
2026 Origin Ale, 30 May 1997
2027 \end_layout
2028
2029 \begin_layout Subsection*
2030 LFUN_BIBTEX_DATABASE_DEL
2031 \end_layout
2032 \begin_layout Description
2033 Action Adds database, which will be used for bibtex citations.
2034 \end_layout
2035 \begin_layout Description
2036 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
2037 \end_layout
2038 \begin_layout Description
2039 Syntax bibtex-database-del <DATABASE-NAME>
2040 \end_layout
2041 \begin_layout Description
2042 Origin Ale, 30 May 1997
2043 \end_layout
2044
2045 \begin_layout Subsection*
2046 LFUN_LAYOUT
2047 \end_layout
2048 \begin_layout Description
2049 Action Sets the layout (that is, environment) for the current paragraph.
2050 \end_layout
2051 \begin_layout Description
2052 Syntax layout <LAYOUT>
2053 \end_layout
2054 \begin_layout Description
2055 Params <LAYOUT>: the layout to use
2056 \end_layout
2057
2058 \begin_layout Subsection*
2059 LFUN_LAYOUT_PARAGRAPH
2060 \end_layout
2061 \begin_layout Description
2062 Action Launches the paragraph settings dialog.
2063 \end_layout
2064 \begin_layout Description
2065 Syntax layout-paragraph
2066 \end_layout
2067
2068 \begin_layout Subsection*
2069 LFUN_LAYOUT_TABULAR
2070 \end_layout
2071 \begin_layout Description
2072 Action Launches the tabular settings dialog.
2073 \end_layout
2074 \begin_layout Description
2075 Syntax layout-tabular
2076 \end_layout
2077 \begin_layout Description
2078 Origin Jug, 31 Jul 2000
2079 \end_layout
2080
2081 \begin_layout Subsection*
2082 LFUN_DROP_LAYOUTS_CHOICE
2083 \end_layout
2084 \begin_layout Description
2085 Action Displays list of layout choices.
2086 \end_layout
2087 \begin_layout Description
2088 Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox allowing for choice of layout.
2089 \end_layout
2090 \begin_layout Description
2091 Syntax drop-layouts-choice
2092 \end_layout
2093
2094 \begin_layout Subsection*
2095 LFUN_LAYOUT_MODULES_CLEAR
2096 \end_layout
2097 \begin_layout Description
2098 Action Clears the module list.
2099 \end_layout
2100 \begin_layout Description
2101 Notion Clears the list of included modules for the current buffer.
2102 \end_layout
2103 \begin_layout Description
2104 Syntax layout-modules-clear
2105 \end_layout
2106 \begin_layout Description
2107 Origin rgh, 25 August 2007
2108 \end_layout
2109
2110 \begin_layout Subsection*
2111 LFUN_LAYOUT_MODULE_ADD
2112 \end_layout
2113 \begin_layout Description
2114 Action Adds a module.
2115 \end_layout
2116 \begin_layout Description
2117 Notion Adds a module to the list of included modules for the current buffer.
2118 \end_layout
2119 \begin_layout Description
2120 Syntax layout-module-add <MODULE>
2121 \end_layout
2122 \begin_layout Description
2123 Params <MODULE>: the module to be added
2124 \end_layout
2125 \begin_layout Description
2126 Origin rgh, 25 August 2007
2127 \end_layout
2128
2129 \begin_layout Subsection*
2130 LFUN_LAYOUT_RELOAD
2131 \end_layout
2132 \begin_layout Description
2133 Action Reloads layout information.
2134 \end_layout
2135 \begin_layout Description
2136 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.
2137 \end_layout
2138 \begin_layout Description
2139 Syntax layout-reload
2140 \end_layout
2141 \begin_layout Description
2142 Origin rgh, 3 September 2007
2143 \end_layout
2144
2145 \begin_layout Subsection*
2146 LFUN_TEXTCLASS_APPLY
2147 \end_layout
2148 \begin_layout Description
2149 Action Sets the text class for the current buffer.
2150 \end_layout
2151 \begin_layout Description
2152 Syntax textclass-apply <TEXTCLASS>
2153 \end_layout
2154 \begin_layout Description
2155 Params <TEXTCLASS>: the textclass to set. Note that this must be the filename, minus the ".layout" extension.
2156 \end_layout
2157
2158 \begin_layout Subsection*
2159 LFUN_TEXTCLASS_LOAD
2160 \end_layout
2161 \begin_layout Description
2162 Action Loads information for a textclass from disk.
2163 \end_layout
2164 \begin_layout Description
2165 Syntax textclass-load <TEXTCLASS>
2166 \end_layout
2167 \begin_layout Description
2168 Params <TEXTCLASS>: the textclass to load. Note that this must be the filename, minus the ".layout" extension.
2169 \end_layout
2170
2171 \begin_layout Subsection*
2172 LFUN_MARK_OFF
2173 \end_layout
2174 \begin_layout Description
2175 Action Disable selecting of text-region.
2176 \end_layout
2177 \begin_layout Description
2178 Syntax mark-off
2179 \end_layout
2180
2181 \begin_layout Subsection*
2182 LFUN_MARK_ON
2183 \end_layout
2184 \begin_layout Description
2185 Action Enable selecting of text-region.
2186 \end_layout
2187 \begin_layout Description
2188 Notion After enabling you can simply move arrow keys to get selected region.
2189 \end_layout
2190 \begin_layout Description
2191 Syntax mark-on
2192 \end_layout
2193
2194 \begin_layout Subsection*
2195 LFUN_MARK_TOGGLE
2196 \end_layout
2197 \begin_layout Description
2198 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
2199 \end_layout
2200 \begin_layout Description
2201 Syntax mark-toggle
2202 \end_layout
2203 \begin_layout Description
2204 Origin Andre, May 5 2006
2205 \end_layout
2206
2207 \begin_layout Subsection*
2208 LFUN_MATH_DELIM
2209 \end_layout
2210 \begin_layout Description
2211 Action Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
2212 \end_layout
2213 \begin_layout Description
2214 Syntax math-delim [<LEFT>] [<RIGHT>]
2215 \end_layout
2216 \begin_layout Description
2217 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.
2218 \end_layout
2219 \begin_layout Description
2220 Sample math-delim { rangle
2221 \end_layout
2222 \begin_layout Description
2223 Origin Alejandro, 18 Jun 1996
2224 \end_layout
2225
2226 \begin_layout Subsection*
2227 LFUN_MATH_BIGDELIM
2228 \end_layout
2229 \begin_layout Description
2230 Action Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
2231 \end_layout
2232 \begin_layout Description
2233 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
2234 \end_layout
2235 \begin_layout Description
2236 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
2237 \begin_inset Newline newline
2238 \end_inset
2239
2240 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
2241 \end_layout
2242 \begin_layout Description
2243 Sample math-bigdelim "Bigl" "
2244 \backslash
2245 Downarrow" "Bigr" "
2246 \backslash
2247 }"
2248 \end_layout
2249 \begin_layout Description
2250 Origin Enrico & Georg, 7 May 2006
2251 \end_layout
2252
2253 \begin_layout Subsection*
2254 LFUN_MATH_DISPLAY
2255 \end_layout
2256 \begin_layout Description
2257 Action Creates a new displayed equation in text mode. Toggles inlined/display formula in math mode.
2258 \end_layout
2259 \begin_layout Description
2260 Syntax math-display [<ARG>]
2261 \end_layout
2262 \begin_layout Description
2263 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating new equation from the text mode.
2264 \end_layout
2265 \begin_layout Description
2266 Origin Alejandro, 18 Jun 1996
2267 \end_layout
2268
2269 \begin_layout Subsection*
2270 LFUN_MATH_INSERT
2271 \end_layout
2272 \begin_layout Description
2273 Action Inserts math objects and symbols.
2274 \end_layout
2275 \begin_layout Description
2276 Notion When <ARG> is a _single_ math inset with more than one cell (such as "x_y^z" or "
2277 \backslash
2278 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
2279 \backslash
2280 frac{x}{y}" replaces "abc" with "
2281 \backslash
2282 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.
2283 \end_layout
2284 \begin_layout Description
2285 Syntax math-insert <ARG>
2286 \end_layout
2287 \begin_layout Description
2288 Params <ARG>: Symbol or LaTeX code to be inserted.
2289 \end_layout
2290
2291 \begin_layout Subsection*
2292 LFUN_MATH_SUBSCRIPT
2293 \end_layout
2294 \begin_layout Description
2295 Action Enters subscript expression in math expression.
2296 \end_layout
2297 \begin_layout Description
2298 Syntax math-subscript
2299 \end_layout
2300 \begin_layout Description
2301 Origin vermeer, 12 Dec 2001
2302 \end_layout
2303
2304 \begin_layout Subsection*
2305 LFUN_MATH_SUPERSCRIPT
2306 \end_layout
2307 \begin_layout Description
2308 Action Enters superscript expression in math expression.
2309 \end_layout
2310 \begin_layout Description
2311 Syntax math-superscript
2312 \end_layout
2313 \begin_layout Description
2314 Origin vermeer, 12 Dec 2001
2315 \end_layout
2316
2317 \begin_layout Subsection*
2318 LFUN_MATH_LIMITS
2319 \end_layout
2320 \begin_layout Description
2321 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.
2322 \end_layout
2323 \begin_layout Description
2324 Notion Put the cursor before the symbol with the limits and then invoke math-limits.
2325 \end_layout
2326 \begin_layout Description
2327 Syntax math-limits [<STATE>]
2328 \end_layout
2329 \begin_layout Description
2330 Params <STATE>: limits|nolimits
2331 \end_layout
2332
2333 \begin_layout Subsection*
2334 LFUN_MATH_MACRO
2335 \end_layout
2336 \begin_layout Description
2337 Action Inserts a math macro definition at the cursor position in the text.
2338 \end_layout
2339 \begin_layout Description
2340 Syntax math-macro <NAME> [<NARGS>] [def]
2341 \end_layout
2342 \begin_layout Description
2343 Params <NAME>: The name of the macro, e.g. "mymacro".
2344 \begin_inset Newline newline
2345 \end_inset
2346
2347 <NARGS>: The number of parameters of the macro. Default is 0. "def": Has no effect anymore, just for compatibility with former LyX versions.
2348 \end_layout
2349 \begin_layout Description
2350 Origin ale, 10 May 1997;  sts, 21 Dec 2007
2351 \end_layout
2352
2353 \begin_layout Subsection*
2354 LFUN_MATH_MUTATE
2355 \end_layout
2356 \begin_layout Description
2357 Action Mutates the type of math inset to the newly selected one.
2358 \end_layout
2359 \begin_layout Description
2360 Syntax math-mutate <TYPE>
2361 \end_layout
2362 \begin_layout Description
2363 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat| multline|gather|flalign
2364 \end_layout
2365 \begin_layout Description
2366 Origin Andre, 23 May 2001
2367 \end_layout
2368
2369 \begin_layout Subsection*
2370 LFUN_MATH_SPACE
2371 \end_layout
2372 \begin_layout Description
2373 Action Inserts space into math expression.
2374 \end_layout
2375 \begin_layout Description
2376 Notion Use spacebar after entering this space to change type of space.
2377 \end_layout
2378 \begin_layout Description
2379 Syntax math-space [<TYPE>] [<LEN>]
2380 \end_layout
2381 \begin_layout Description
2382 Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
2383 \begin_inset Newline newline
2384 \end_inset
2385
2386 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
2387 \begin_inset Newline newline
2388 \end_inset
2389
2390 custom space: hspace
2391 \begin_inset Newline newline
2392 \end_inset
2393
2394 "," used by default.
2395 \begin_inset Newline newline
2396 \end_inset
2397
2398 Note that ! is equivalent to negthinspace, , = thinspace, : = medspace, and ; = thickspace.
2399 \begin_inset Newline newline
2400 \end_inset
2401
2402 <LEN>: length for custom spaces (hspace)
2403 \end_layout
2404 \begin_layout Description
2405 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
2406 \end_layout
2407
2408 \begin_layout Subsection*
2409 LFUN_MATH_MATRIX
2410 \end_layout
2411 \begin_layout Description
2412 Action Inserts a matrix.
2413 \end_layout
2414 \begin_layout Description
2415 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
2416 \end_layout
2417 \begin_layout Description
2418 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).
2419 \end_layout
2420 \begin_layout Description
2421 Sample math-matrix 3 3 bccc
2422 \end_layout
2423
2424 \begin_layout Subsection*
2425 LFUN_MATH_AMS_MATRIX
2426 \end_layout
2427 \begin_layout Description
2428 Action Inserts a matrix.
2429 \end_layout
2430 \begin_layout Description
2431 Syntax math-matrix <COLS> <ROWS> [<DECORATION>]
2432 \end_layout
2433 \begin_layout Description
2434 Params <DECORATION>: Decoration determines the LaTeX name of the matrix that should be created.
2435 \end_layout
2436 \begin_layout Description
2437 Sample math-ams-matrix 3 3 bmatrix
2438 \end_layout
2439
2440 \begin_layout Subsection*
2441 LFUN_MATH_MODE
2442 \end_layout
2443 \begin_layout Description
2444 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.
2445 \end_layout
2446 \begin_layout Description
2447 Notion If there is some selected text, it puts the text inside created math box.
2448 \end_layout
2449 \begin_layout Description
2450 Syntax math-mode [on|<ARG>]
2451 \end_layout
2452 \begin_layout Description
2453 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT .
2454 \begin_inset Newline newline
2455 \end_inset
2456
2457 "on": allow only entering of math mode from text mode.
2458 \end_layout
2459 \begin_layout Description
2460 Origin Alejandro, 4 Jun 1996
2461 \end_layout
2462
2463 \begin_layout Subsection*
2464 LFUN_REGEXP_MODE
2465 \end_layout
2466 \begin_layout Description
2467 Action Enters regexp mode (i.e., puts regexp insets on the current cursor position). Used by the advanced search dialog.
2468 \end_layout
2469 \begin_layout Description
2470 Notion If there is any selected text, then it is moved inside the created regexp inset.
2471 \end_layout
2472 \begin_layout Description
2473 Syntax regexp-mode [<ARG>]
2474 \end_layout
2475 \begin_layout Description
2476 Params <ARG>: eventual argument (regular expression).
2477 \end_layout
2478 \begin_layout Description
2479 Origin Tommaso, 4 Oct 2008
2480 \end_layout
2481
2482 \begin_layout Subsection*
2483 LFUN_MATH_NUMBER_LINE_TOGGLE
2484 \end_layout
2485 \begin_layout Description
2486 Action Toggles numbering of the current formula line.
2487 \end_layout
2488 \begin_layout Description
2489 Notion Must be in display formula mode.
2490 \end_layout
2491 \begin_layout Description
2492 Syntax math-number-line-toggle
2493 \end_layout
2494 \begin_layout Description
2495 Origin Alejandro, 18 Jun 1996
2496 \end_layout
2497
2498 \begin_layout Subsection*
2499 LFUN_MATH_NUMBER_TOGGLE
2500 \end_layout
2501 \begin_layout Description
2502 Action Toggles numbering/labeling of the current formula.
2503 \end_layout
2504 \begin_layout Description
2505 Notion Must be in display formula mode.
2506 \end_layout
2507 \begin_layout Description
2508 Syntax math-number-toggle
2509 \end_layout
2510 \begin_layout Description
2511 Origin Alejandro, 4 Jun 1996
2512 \end_layout
2513
2514 \begin_layout Subsection*
2515 LFUN_MATH_EXTERN
2516 \end_layout
2517 \begin_layout Description
2518 Action Calls external program and passes the current expression/equation as an argument for the calculation in the format appropriate to the given language.
2519 \end_layout
2520 \begin_layout Description
2521 Notion Selection can be used to determine the input for the external program.
2522 \end_layout
2523 \begin_layout Description
2524 Syntax math-extern <LANG> [<COMMAND>]
2525 \end_layout
2526 \begin_layout Description
2527 Params <LANG>: octave|maxima|maple|mathematica|script
2528 \begin_inset Newline newline
2529 \end_inset
2530
2531 where "script" stands fot the external script (normalized expression will be passed)
2532 \end_layout
2533 \begin_layout Description
2534 Sample math-extern maple simplify
2535 \end_layout
2536 \begin_layout Description
2537 Origin Andre, 24 Apr 2001
2538 \end_layout
2539
2540 \begin_layout Subsection*
2541 LFUN_MATH_SIZE
2542 \end_layout
2543 \begin_layout Description
2544 Action Changes arbitrarily the size used by math fonts inside a context.
2545 \end_layout
2546 \begin_layout Description
2547 Notion Provides an interface to the LaTeX math mode font size commands.
2548 \end_layout
2549 \begin_layout Description
2550 Syntax math-size <STYLE>
2551 \end_layout
2552 \begin_layout Description
2553 Params <STYLE>:
2554 \backslash
2555 displaystyle|
2556 \backslash
2557 textstyle|
2558 \backslash
2559 scriptstyle|
2560 \backslash
2561 scriptscriptstyle
2562 \end_layout
2563 \begin_layout Description
2564 Origin Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
2565 \end_layout
2566
2567 \begin_layout Subsection*
2568 LFUN_MATH_FONT_STYLE
2569 \end_layout
2570 \begin_layout Description
2571 Action Changes the text style used in math.
2572 \end_layout
2573 \begin_layout Description
2574 Syntax math-font-style <STYLE>
2575 \end_layout
2576 \begin_layout Description
2577 Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal
2578 \begin_inset Newline newline
2579 \end_inset
2580
2581 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
2582 \end_layout
2583 \begin_layout Description
2584 Origin vfr, 9 jan 2009
2585 \end_layout
2586
2587 \begin_layout Subsection*
2588 LFUN_MATH_MACRO_UNFOLD
2589 \end_layout
2590 \begin_layout Description
2591 Action Unfold a Math Macro.
2592 \end_layout
2593 \begin_layout Description
2594 Notion Unfold the Math Macro the cursor is in, i.e. display it as
2595 \backslash
2596 foo.
2597 \end_layout
2598 \begin_layout Description
2599 Syntax math-macro-unfold
2600 \end_layout
2601 \begin_layout Description
2602 Origin sts, 06 January 2008
2603 \end_layout
2604
2605 \begin_layout Subsection*
2606 LFUN_MATH_MACRO_FOLD
2607 \end_layout
2608 \begin_layout Description
2609 Action Fold a Math Macro.
2610 \end_layout
2611 \begin_layout Description
2612 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e. displayed as
2613 \backslash
2614 foo before.
2615 \end_layout
2616 \begin_layout Description
2617 Syntax math-macro-fold
2618 \end_layout
2619 \begin_layout Description
2620 Origin sts, 06 January 2008
2621 \end_layout
2622
2623 \begin_layout Subsection*
2624 LFUN_MATH_MACRO_ADD_PARAM
2625 \end_layout
2626 \begin_layout Description
2627 Action Add a parameter.
2628 \end_layout
2629 \begin_layout Description
2630 Notion Add a parameter to a Math Macro.
2631 \end_layout
2632 \begin_layout Description
2633 Syntax math-macro-add-param <NUM>
2634 \end_layout
2635 \begin_layout Description
2636 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.
2637 \end_layout
2638 \begin_layout Description
2639 Origin sts, 06 January 2008
2640 \end_layout
2641
2642 \begin_layout Subsection*
2643 LFUN_MATH_MACRO_REMOVE_PARAM
2644 \end_layout
2645 \begin_layout Description
2646 Action Remove the last parameter.
2647 \end_layout
2648 \begin_layout Description
2649 Notion Remove the last parameter of a Math Macro and remove its value in all instances of the macro in the buffer.
2650 \end_layout
2651 \begin_layout Description
2652 Syntax math-macro-remove-param <NUM>
2653 \end_layout
2654 \begin_layout Description
2655 Params <NUM>: The number of the parameter to be deleted (1 for the first), defaults to the last one.
2656 \end_layout
2657 \begin_layout Description
2658 Origin sts, 06 January 2008
2659 \end_layout
2660
2661 \begin_layout Subsection*
2662 LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
2663 \end_layout
2664 \begin_layout Description
2665 Action Append a greedy parameter.
2666 \end_layout
2667 \begin_layout Description
2668 Notion Append a greedy parameter to a Math Macro which eats the following mathed cell in every instance of the macro in the buffer.
2669 \end_layout
2670 \begin_layout Description
2671 Syntax math-macro-append-greedy-param
2672 \end_layout
2673 \begin_layout Description
2674 Origin sts, 06 January 2008
2675 \end_layout
2676
2677 \begin_layout Subsection*
2678 LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
2679 \end_layout
2680 \begin_layout Description
2681 Action Remove a greedy parameter.
2682 \end_layout
2683 \begin_layout Description
2684 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.
2685 \end_layout
2686 \begin_layout Description
2687 Syntax math-macro-remove-greedy-param
2688 \end_layout
2689 \begin_layout Description
2690 Origin sts, 06 January 2008
2691 \end_layout
2692
2693 \begin_layout Subsection*
2694 LFUN_MATH_MACRO_MAKE_OPTIONAL
2695 \end_layout
2696 \begin_layout Description
2697 Action Make a parameter optional.
2698 \end_layout
2699 \begin_layout Description
2700 Notion Turn the first non-optional parameter of a Math Macro into an optional parameter with a default value.
2701 \end_layout
2702 \begin_layout Description
2703 Syntax math-macro-make-optional
2704 \end_layout
2705 \begin_layout Description
2706 Origin sts, 06 January 2008
2707 \end_layout
2708
2709 \begin_layout Subsection*
2710 LFUN_MATH_MACRO_MAKE_NONOPTIONAL
2711 \end_layout
2712 \begin_layout Description
2713 Action Make a parameter non-optional.
2714 \end_layout
2715 \begin_layout Description
2716 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.
2717 \end_layout
2718 \begin_layout Description
2719 Syntax math-macro-make-nonoptional
2720 \end_layout
2721 \begin_layout Description
2722 Origin sts, 06 January 2008
2723 \end_layout
2724
2725 \begin_layout Subsection*
2726 LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
2727 \end_layout
2728 \begin_layout Description
2729 Action Add an optional parameter.
2730 \end_layout
2731 \begin_layout Description
2732 Notion Insert an optional parameter just behind the already existing optional parameters.
2733 \end_layout
2734 \begin_layout Description
2735 Syntax math-macro-add-optional-param
2736 \end_layout
2737 \begin_layout Description
2738 Origin sts, 06 January 2008
2739 \end_layout
2740
2741 \begin_layout Subsection*
2742 LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
2743 \end_layout
2744 \begin_layout Description
2745 Action Remove the last optional parameter.
2746 \end_layout
2747 \begin_layout Description
2748 Notion Remove the last optional parameter of a Math Macro and remove it in all the instances of the macro in the buffer.
2749 \end_layout
2750 \begin_layout Description
2751 Syntax math-macro-remove-optional-param
2752 \end_layout
2753 \begin_layout Description
2754 Origin sts, 06 January 2008
2755 \end_layout
2756
2757 \begin_layout Subsection*
2758 LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
2759 \end_layout
2760 \begin_layout Description
2761 Action Add a greedy optional parameter.
2762 \end_layout
2763 \begin_layout Description
2764 Notion Add a greedy optional parameter which eats the value from the following cells in mathed which are in the [value] format.
2765 \end_layout
2766 \begin_layout Description
2767 Syntax math-macro-add-greedy-optional-param
2768 \end_layout
2769 \begin_layout Description
2770 Origin sts, 06 January 2008
2771 \end_layout
2772
2773 \begin_layout Subsection*
2774 LFUN_IN_MATHMACROTEMPLATE
2775 \end_layout
2776 \begin_layout Description
2777 Action Only active in Math Macro definition.
2778 \end_layout
2779 \begin_layout Description
2780 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.
2781 \end_layout
2782 \begin_layout Description
2783 Syntax in-mathmacrotemplate
2784 \end_layout
2785 \begin_layout Description
2786 Origin sts, 06 January 2008
2787 \end_layout
2788
2789 \begin_layout Subsection*
2790 LFUN_PARAGRAPH_MOVE_DOWN
2791 \end_layout
2792 \begin_layout Description
2793 Action Moves the current paragraph downwards in the document.
2794 \end_layout
2795 \begin_layout Description
2796 Syntax paragraph-move-down
2797 \end_layout
2798 \begin_layout Description
2799 Origin Edwin, 8 Apr 2006
2800 \end_layout
2801
2802 \begin_layout Subsection*
2803 LFUN_PARAGRAPH_MOVE_UP
2804 \end_layout
2805 \begin_layout Description
2806 Action Moves the current paragraph upwards in the document.
2807 \end_layout
2808 \begin_layout Description
2809 Syntax paragraph-move-up
2810 \end_layout
2811 \begin_layout Description
2812 Origin Edwin, 8 Apr 2006
2813 \end_layout
2814
2815 \begin_layout Subsection*
2816 LFUN_PARAGRAPH_UP
2817 \end_layout
2818 \begin_layout Description
2819 Action Move the cursor to the next paragraph (or begining of the current one) in upward direction.
2820 \end_layout
2821 \begin_layout Description
2822 Syntax paragraph-up
2823 \end_layout
2824 \begin_layout Description
2825 Origin Asger, 1 Oct 1996
2826 \end_layout
2827
2828 \begin_layout Subsection*
2829 LFUN_PARAGRAPH_UP_SELECT
2830 \end_layout
2831 \begin_layout Description
2832 Action Move the cursor and select the text to the next paragraph (or begining of the current one) in upward direction.
2833 \end_layout
2834 \begin_layout Description
2835 Syntax paragraph-up-select
2836 \end_layout
2837 \begin_layout Description
2838 Origin Asger, 1 Oct 1996
2839 \end_layout
2840
2841 \begin_layout Subsection*
2842 LFUN_PARAGRAPH_DOWN
2843 \end_layout
2844 \begin_layout Description
2845 Action Move the cursor to the next paragraph (or begining of the current one) in downward direction.
2846 \end_layout
2847 \begin_layout Description
2848 Syntax paragraph-down
2849 \end_layout
2850 \begin_layout Description
2851 Origin Asger, 1 Oct 1996
2852 \end_layout
2853
2854 \begin_layout Subsection*
2855 LFUN_PARAGRAPH_DOWN_SELECT
2856 \end_layout
2857 \begin_layout Description
2858 Action Move the cursor and select the text to the next paragraph (or begining of the current one) in downward direction.
2859 \end_layout
2860 \begin_layout Description
2861 Syntax paragraph-down-select
2862 \end_layout
2863 \begin_layout Description
2864 Origin Asger, 1 Oct 1996
2865 \end_layout
2866
2867 \begin_layout Subsection*
2868 LFUN_PARAGRAPH_GOTO
2869 \end_layout
2870 \begin_layout Description
2871 Action Jump to a paragraph given by its id number and optionally the desired position within the paragraph.
2872 \end_layout
2873 \begin_layout Description
2874 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).
2875 \end_layout
2876 \begin_layout Description
2877 Syntax paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
2878 \end_layout
2879 \begin_layout Description
2880 Params <PAR_ID_NUMBER>:  paragraph id
2881 \begin_inset Newline newline
2882 \end_inset
2883
2884 <POSITION_IN_PAR>: desired position within the paragraph
2885 \end_layout
2886 \begin_layout Description
2887 Origin Dekel, 26 Aug 2000
2888 \end_layout
2889
2890 \begin_layout Subsection*
2891 LFUN_BREAK_PARAGRAPH
2892 \end_layout
2893 \begin_layout Description
2894 Action Breaks the current paragraph at the current location.
2895 \end_layout
2896 \begin_layout Description
2897 Notion Removes the selection.
2898 \end_layout
2899 \begin_layout Description
2900 Syntax break-paragraph [<LAYOUT>]
2901 \end_layout
2902 \begin_layout Description
2903 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to default layout) when the cursor is at the end of the line.
2904 \end_layout
2905
2906 \begin_layout Subsection*
2907 LFUN_PARAGRAPH_PARAMS
2908 \end_layout
2909 \begin_layout Description
2910 Action Change paragraph settings.
2911 \end_layout
2912 \begin_layout Description
2913 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.
2914 \end_layout
2915 \begin_layout Description
2916 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
2917 \end_layout
2918 \begin_layout Description
2919 Params <INDENT>:
2920 \backslash
2921 noindent|
2922 \backslash
2923 indent|
2924 \backslash
2925 indent-toggle|
2926 \backslash
2927 leftindent LENGTH
2928 \begin_inset Newline newline
2929 \end_inset
2930
2931 <SPACING>:
2932 \backslash
2933 paragraph_spacing default|single|onehalf|double|other SIZE
2934 \begin_inset Newline newline
2935 \end_inset
2936
2937 <ALIGN>:
2938 \backslash
2939 align block|left|right|center|default
2940 \begin_inset Newline newline
2941 \end_inset
2942
2943 <OTHERS>:
2944 \backslash
2945 labelwidthstring WIDTH|
2946 \backslash
2947 start_of_appendix
2948 \end_layout
2949 \begin_layout Description
2950 Origin rgh, Aug 15 2007
2951 \end_layout
2952
2953 \begin_layout Subsection*
2954 LFUN_PARAGRAPH_PARAMS_APPLY
2955 \end_layout
2956 \begin_layout Description
2957 Action Change paragraph settings.
2958 \end_layout
2959 \begin_layout Description
2960 Notion Overwrite all nonspecified settings to the default ones. Use paragraph-params lfun if you don't want to overwrite others settings.
2961 \end_layout
2962 \begin_layout Description
2963 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
2964 \end_layout
2965 \begin_layout Description
2966 Params For parameters see LFUN_PARAGRAPH_PARAMS
2967 \end_layout
2968 \begin_layout Description
2969 Origin leeming, 30 Mar 2004
2970 \end_layout
2971
2972 \begin_layout Subsection*
2973 LFUN_PARAGRAPH_UPDATE
2974 \end_layout
2975 \begin_layout Description
2976 Action Updates the values inside the paragraph dialog from the paragraph.
2977 \end_layout
2978 \begin_layout Description
2979 Notion This is internal LFUN, not to be used by users. Called internally by LFUN_DIALOG_UPDATE.
2980 \end_layout
2981 \begin_layout Description
2982 Origin leeming, 13 Mar 2003
2983 \end_layout
2984
2985 \begin_layout Subsection*
2986 LFUN_OUTLINE_UP
2987 \end_layout
2988 \begin_layout Description
2989 Action Move the current group in the upward direction in the structure of the document.
2990 \end_layout
2991 \begin_layout Description
2992 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
2993 \end_layout
2994 \begin_layout Description
2995 Syntax outline-up
2996 \end_layout
2997 \begin_layout Description
2998 Origin Vermeer, 23 Mar 2006
2999 \end_layout
3000
3001 \begin_layout Subsection*
3002 LFUN_OUTLINE_DOWN
3003 \end_layout
3004 \begin_layout Description
3005 Action Move the current group in the downward direction in the structure of the document.
3006 \end_layout
3007 \begin_layout Description
3008 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
3009 \end_layout
3010 \begin_layout Description
3011 Syntax outline-down
3012 \end_layout
3013 \begin_layout Description
3014 Origin Vermeer, 23 Mar 2006
3015 \end_layout
3016
3017 \begin_layout Subsection*
3018 LFUN_OUTLINE_IN
3019 \end_layout
3020 \begin_layout Description
3021 Action Moves the current group in the downward direction in the hierarchy of the document structure.
3022 \end_layout
3023 \begin_layout Description
3024 Notion Part -> Chapter -> Section -> etc.
3025 \end_layout
3026 \begin_layout Description
3027 Syntax outline-in
3028 \end_layout
3029 \begin_layout Description
3030 Origin Vermeer, 23 Mar 2006
3031 \end_layout
3032
3033 \begin_layout Subsection*
3034 LFUN_OUTLINE_OUT
3035 \end_layout
3036 \begin_layout Description
3037 Action Moves the current group in the upward direction in the hierarchy of the document structure.
3038 \end_layout
3039 \begin_layout Description
3040 Notion Part <- Chapter <- Section <- etc.
3041 \end_layout
3042 \begin_layout Description
3043 Syntax outline-out
3044 \end_layout
3045 \begin_layout Description
3046 Origin Vermeer, 23 Mar 2006
3047 \end_layout
3048
3049 \begin_layout Subsection*
3050 LFUN_INSET_EDIT
3051 \end_layout
3052 \begin_layout Description
3053 Action Edit the inset at cursor with an external application, if one is attributed.
3054 \end_layout
3055 \begin_layout Description
3056 Syntax inset-edit [<INSET_PARAMS>]
3057 \end_layout
3058 \begin_layout Description
3059 Params <INSET_PARAMS>: Parameters for the inset.
3060 \begin_inset Newline newline
3061 \end_inset
3062
3063 Currently only the filename will be considered.
3064 \end_layout
3065 \begin_layout Description
3066 Origin JSpitzm, 27 Apr 2006
3067 \end_layout
3068
3069 \begin_layout Subsection*
3070 LFUN_TABULAR_INSERT
3071 \end_layout
3072 \begin_layout Description
3073 Action Inserts table into the document.
3074 \end_layout
3075 \begin_layout Description
3076 Notion See LFUN_INSET_MODIFY for some more details about tabular modifications.
3077 \end_layout
3078 \begin_layout Description
3079 Syntax tabular-insert [<ROWS> <COLUMNS>]
3080 \end_layout
3081 \begin_layout Description
3082 Params In case no arguments are given show insert dialog.
3083 \end_layout
3084 \begin_layout Description
3085 Origin Jug, 12 Apr 2000
3086 \end_layout
3087
3088 \begin_layout Subsection*
3089 LFUN_CELL_BACKWARD
3090 \end_layout
3091 \begin_layout Description
3092 Action Moves the cursor to the previous cell inside the table.
3093 \end_layout
3094 \begin_layout Description
3095 Syntax cell-backward
3096 \end_layout
3097 \begin_layout Description
3098 Origin Jug, 22 May 2000
3099 \end_layout
3100
3101 \begin_layout Subsection*
3102 LFUN_CELL_FORWARD
3103 \end_layout
3104 \begin_layout Description
3105 Action Moves the cursor to the next cell inside the table.
3106 \end_layout
3107 \begin_layout Description
3108 Syntax cell-forward
3109 \end_layout
3110
3111 \begin_layout Subsection*
3112 LFUN_CELL_SPLIT
3113 \end_layout
3114 \begin_layout Description
3115 Action Splits cell and shifts right part to the next cell (inside the math grid).
3116 \end_layout
3117 \begin_layout Description
3118 Syntax cell-split
3119 \end_layout
3120 \begin_layout Description
3121 Origin Ale, 15 May 1997
3122 \end_layout
3123
3124 \begin_layout Subsection*
3125 LFUN_VC_REGISTER
3126 \end_layout
3127 \begin_layout Description
3128 Action Register the document as an file inside version control system.
3129 \end_layout
3130 \begin_layout Description
3131 Notion File is registered inside cvs, svn or rcs repository acording to the existence of cvs/svn/rcs entries in the document's directory.
3132 \begin_inset Newline newline
3133 \end_inset
3134
3135 See LyX Additional Features Manual (Version Control Chapter) for additional information.
3136 \end_layout
3137 \begin_layout Description
3138 Syntax vc-register
3139 \end_layout
3140 \begin_layout Description
3141 Origin Lgb, 1 Jul 1997
3142 \end_layout
3143
3144 \begin_layout Subsection*
3145 LFUN_VC_CHECK_IN
3146 \end_layout
3147 \begin_layout Description
3148 Action Checks-in/commits the changes of the registered file to the repository.
3149 \end_layout
3150 \begin_layout Description
3151 Notion In RCS case this also unlocks the file.
3152 \end_layout
3153 \begin_layout Description
3154 Syntax vc-check-in
3155 \end_layout
3156 \begin_layout Description
3157 Origin Lgb, 1 Jul 1997
3158 \end_layout
3159
3160 \begin_layout Subsection*
3161 LFUN_VC_CHECK_OUT
3162 \end_layout
3163 \begin_layout Description
3164 Action Checks-out the document for edit (and locks it in some cases).
3165 \end_layout
3166 \begin_layout Description
3167 Syntax vc-check-out
3168 \end_layout
3169 \begin_layout Description
3170 Origin Lgb, 1 Jul 1997
3171 \end_layout
3172
3173 \begin_layout Subsection*
3174 LFUN_VC_REVERT
3175 \end_layout
3176 \begin_layout Description
3177 Action Reverts the document to the last check-in/commit in VCS.
3178 \end_layout
3179 \begin_layout Description
3180 Syntax vc-revert
3181 \end_layout
3182 \begin_layout Description
3183 Origin Lgb, 1 Jul 1997
3184 \end_layout
3185
3186 \begin_layout Subsection*
3187 LFUN_VC_UNDO_LAST
3188 \end_layout
3189 \begin_layout Description
3190 Action Undo last check-in.
3191 \end_layout
3192 \begin_layout Description
3193 Notion This is currently implemented only for RCS.
3194 \end_layout
3195 \begin_layout Description
3196 Syntax vc-check-out
3197 \end_layout
3198 \begin_layout Description
3199 Origin Lgb, 1 Jul 1997
3200 \end_layout
3201
3202 \begin_layout Subsection*
3203 LFUN_VC_COMMAND
3204 \end_layout
3205 \begin_layout Description
3206 Action Executes external command. This command is intended to support additional VCS commands.
3207 \end_layout
3208 \begin_layout Description
3209 Syntax vc-command <FLAG> <PATH> <COMMAND>
3210 \end_layout
3211 \begin_layout Description
3212 Params  <FLAG>: Flags for the command can be combined together.
3213 \begin_inset Newline newline
3214 \end_inset
3215
3216 U - dUmmy - no flags
3217 \begin_inset Newline newline
3218 \end_inset
3219
3220 D - Doc - need document loaded to proceed
3221 \begin_inset Newline newline
3222 \end_inset
3223
3224 I - dIrty - mark document dirty
3225 \begin_inset Newline newline
3226 \end_inset
3227
3228 R - Reload - ensure that the document is saved and reload it after command execution
3229 \begin_inset Newline newline
3230 \end_inset
3231
3232 M - Message - ask for input string (commit message)
3233 \begin_inset Newline newline
3234 \end_inset
3235
3236 <PATH>: path where to start. $$p will be replaced by the current document path.
3237 \begin_inset Newline newline
3238 \end_inset
3239
3240 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current document(with absolute path)/path/message.
3241 \end_layout
3242 \begin_layout Description
3243 Sample vc-command DR $$p "svn up"
3244 \end_layout
3245 \begin_layout Description
3246 Origin sanda, 13 Jan 2009
3247 \end_layout
3248
3249 \begin_layout Subsection*
3250 LFUN_VC_LOCKING_TOGGLE
3251 \end_layout
3252 \begin_layout Description
3253 Action Toggles the locking property of the edited file.
3254 \end_layout
3255 \begin_layout Description
3256 Notion This is currently implemented only for SVN.
3257 \end_layout
3258 \begin_layout Description
3259 Syntax vc-locking-toggle
3260 \end_layout
3261 \begin_layout Description
3262 Origin sanda, 25 Jun 2009
3263 \end_layout
3264
3265 \begin_layout Subsection*
3266 LFUN_VC_REPO_UPDATE
3267 \end_layout
3268 \begin_layout Description
3269 Action Update the local archive directory in which resides the current document with the remote repository.
3270 \end_layout
3271 \begin_layout Description
3272 Syntax vc-repo-update
3273 \end_layout
3274 \begin_layout Description
3275 Origin sanda, 16 Oct 2009
3276 \end_layout
3277
3278 \begin_layout Subsection*
3279 LFUN_VC_COMPARE
3280 \end_layout
3281 \begin_layout Description
3282 Action Compares two revisions of the same file under version control.
3283 \end_layout
3284 \begin_layout Description
3285 Syntax vc-compare [<REV1>] [<REV2>]
3286 \end_layout
3287 \begin_layout Description
3288 Params Revision number either points directly to commit in history or if negative number -x it points to (last commit - x).
3289 \begin_inset Newline newline
3290 \end_inset
3291
3292                In RCS we subtract only in the last number of revision specification. Special case "0" is reserved for the last committed revision.
3293 \begin_inset Newline newline
3294 \end_inset
3295
3296 <REV1>: Older file.
3297 \begin_inset Newline newline
3298 \end_inset
3299
3300                <REV2>: Newer file. Used only if REV1 > 0.
3301 \begin_inset Newline newline
3302 \end_inset
3303
3304 If no parameter is given, interactive dialog will be shown.
3305 \end_layout
3306 \begin_layout Description
3307 Sample Compare current document against last commit
3308 \begin_inset Newline newline
3309 \end_inset
3310
3311                vc-compare 0
3312 \begin_inset Newline newline
3313 \end_inset
3314
3315 Compare current document against current revision - 5 commits
3316 \begin_inset Newline newline
3317 \end_inset
3318
3319                vc-compare -5
3320 \begin_inset Newline newline
3321 \end_inset
3322
3323 Compare revisions 120 and 155
3324 \begin_inset Newline newline
3325 \end_inset
3326
3327                vc-compare 120 155
3328 \end_layout
3329 \begin_layout Description
3330 Origin sanda, 12 Feb 2010
3331 \end_layout
3332
3333 \begin_layout Subsection*
3334 LFUN_CHANGES_TRACK
3335 \end_layout
3336 \begin_layout Description
3337 Action Toggles change tracking to on/off.
3338 \end_layout
3339 \begin_layout Description
3340 Syntax changes-track
3341 \end_layout
3342 \begin_layout Description
3343 Origin levon, 1 Oct 2002
3344 \end_layout
3345
3346 \begin_layout Subsection*
3347 LFUN_CHANGES_OUTPUT
3348 \end_layout
3349 \begin_layout Description
3350 Action Toggles showing of change tracking in typesetted output.
3351 \end_layout
3352 \begin_layout Description
3353 Syntax changes-output
3354 \end_layout
3355 \begin_layout Description
3356 Origin jspitzm, 21 Jan 2005
3357 \end_layout
3358
3359 \begin_layout Subsection*
3360 LFUN_CHANGE_NEXT
3361 \end_layout
3362 \begin_layout Description
3363 Action Moves the cursor to the position of the next change of the change tracking records.
3364 \end_layout
3365 \begin_layout Description
3366 Syntax change-next
3367 \end_layout
3368 \begin_layout Description
3369 Origin schmitt, 4 Oct 2006
3370 \end_layout
3371
3372 \begin_layout Subsection*
3373 LFUN_CHANGE_PREVIOUS
3374 \end_layout
3375 \begin_layout Description
3376 Action Moves the cursor to the position of the previous change of the change tracking records.
3377 \end_layout
3378 \begin_layout Description
3379 Syntax change-previous
3380 \end_layout
3381 \begin_layout Description
3382 Origin vfr, 4 Apr 2009
3383 \end_layout
3384
3385 \begin_layout Subsection*
3386 LFUN_CHANGES_MERGE
3387 \end_layout
3388 \begin_layout Description
3389 Action Open change tracking dialog for merging and moves the cursor to the position of the next change.
3390 \end_layout
3391 \begin_layout Description
3392 Syntax changes-merge
3393 \end_layout
3394 \begin_layout Description
3395 Origin Levon, 16 Oct 2002
3396 \end_layout
3397
3398 \begin_layout Subsection*
3399 LFUN_CHANGE_ACCEPT
3400 \end_layout
3401 \begin_layout Description
3402 Action Accepts tracked change inside the selection.
3403 \end_layout
3404 \begin_layout Description
3405 Syntax change-accept
3406 \end_layout
3407 \begin_layout Description
3408 Origin Levon, 16 Oct 2002
3409 \end_layout
3410
3411 \begin_layout Subsection*
3412 LFUN_CHANGE_REJECT
3413 \end_layout
3414 \begin_layout Description
3415 Action Rejects tracked change inside the selection.
3416 \end_layout
3417 \begin_layout Description
3418 Syntax change-reject
3419 \end_layout
3420 \begin_layout Description
3421 Origin Levon, 16 Oct 2002
3422 \end_layout
3423
3424 \begin_layout Subsection*
3425 LFUN_ALL_CHANGES_ACCEPT
3426 \end_layout
3427 \begin_layout Description
3428 Action Accepts all tracked changes in the document.
3429 \end_layout
3430 \begin_layout Description
3431 Syntax all-changes-accept
3432 \end_layout
3433 \begin_layout Description
3434 Origin Levon, 16 Oct 2002
3435 \end_layout
3436
3437 \begin_layout Subsection*
3438 LFUN_ALL_CHANGES_REJECT
3439 \end_layout
3440 \begin_layout Description
3441 Action Rejects all tracked changes in the document.
3442 \end_layout
3443 \begin_layout Description
3444 Notion Reject does not work recursively; the user may have to repeat the operation.
3445 \end_layout
3446 \begin_layout Description
3447 Syntax all-changes-reject
3448 \end_layout
3449 \begin_layout Description
3450 Origin Levon, 16 Oct 2002
3451 \end_layout
3452
3453 \begin_layout Subsection*
3454 LFUN_INSET_APPLY
3455 \end_layout
3456 \begin_layout Description
3457 Action Apply data for an inset.
3458 \end_layout
3459 \begin_layout Description
3460 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.
3461 \end_layout
3462 \begin_layout Description
3463 Syntax inset-apply <ARGS>
3464 \end_layout
3465 \begin_layout Description
3466 Params See LFUN_INSET_INSERT .
3467 \end_layout
3468
3469 \begin_layout Subsection*
3470 LFUN_INSET_DISSOLVE
3471 \end_layout
3472 \begin_layout Description
3473 Action Dissolve the current inset into text.
3474 \end_layout
3475 \begin_layout Description
3476 Syntax inset-dissolve [<INSET>]
3477 \end_layout
3478 \begin_layout Description
3479 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.
3480 \begin_inset Newline newline
3481 \end_inset
3482
3483 For values see lyx::InsetLayout::lyxtype_ .
3484 \end_layout
3485 \begin_layout Description
3486 Origin JSpitz, 7 Aug 2006
3487 \end_layout
3488
3489 \begin_layout Subsection*
3490 LFUN_INSET_INSERT
3491 \end_layout
3492 \begin_layout Description
3493 Action Insert new inset (type given by the parameters).
3494 \end_layout
3495 \begin_layout Description
3496 Syntax inset-insert <INSET> <ARGS>
3497 \end_layout
3498 \begin_layout Description
3499 Params <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|tabular|
3500 \begin_inset Newline newline
3501 \end_inset
3502
3503                          hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>
3504 \begin_inset Newline newline
3505 \end_inset
3506
3507 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
3508 \end_layout
3509 \begin_layout Description
3510 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
3511 \backslash
3512 end_inset
3513 \begin_inset Newline newline
3514 \end_inset
3515
3516 where <label name> is the name of the referenced label and <Format> is one of the following:
3517 \begin_inset Newline newline
3518 \end_inset
3519
3520 ref -- <reference>
3521 \begin_inset Newline newline
3522 \end_inset
3523
3524 eqref -- (<reference>)
3525 \begin_inset Newline newline
3526 \end_inset
3527
3528 pageref -- <page>
3529 \begin_inset Newline newline
3530 \end_inset
3531
3532 vpageref -- on <page>
3533 \begin_inset Newline newline
3534 \end_inset
3535
3536 vref -- <reference> on <page>
3537 \begin_inset Newline newline
3538 \end_inset
3539
3540 formatted -- Formatted reference
3541 \end_layout
3542
3543 \begin_layout Subsection*
3544 LFUN_INSET_MODIFY
3545 \end_layout
3546 \begin_layout Description
3547 Action Modify some properties of an inset.
3548 \end_layout
3549 \begin_layout Description
3550 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.
3551 \end_layout
3552 \begin_layout Description
3553 Syntax inset-modify <INSET> <ARGS>inset-modify changetype <TYPE>inset-modify tabular <FEATURE> [<ARG>]
3554 \end_layout
3555 \begin_layout Description
3556 Params Generally see LFUN_INSET_INSERT for further details.
3557 \begin_inset Newline newline
3558 \end_inset
3559
3560 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.
3561 \begin_inset Newline newline
3562 \end_inset
3563
3564 <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|set-tabular-width
3565 \begin_inset Newline newline
3566 \end_inset
3567
3568 <ARG>: additional argument for some commands, use debug mode to explore its values.
3569 \end_layout
3570 \begin_layout Description
3571 Sample inset-modify note Note Comment
3572 \begin_inset Newline newline
3573 \end_inset
3574
3575                inset-modify changetype Ovalbox
3576 \end_layout
3577
3578 \begin_layout Subsection*
3579 LFUN_INSET_DIALOG_UPDATE
3580 \end_layout
3581 \begin_layout Description
3582 Action Updates the values inside the dialog from the inset.
3583 \end_layout
3584 \begin_layout Description
3585 Notion This is internal LFUN, not to be used by users. Called internally by LFUN_DIALOG_UPDATE
3586 \end_layout
3587 \begin_layout Description
3588 Params <DIALOG-NAME>
3589 \end_layout
3590 \begin_layout Description
3591 Origin leeming, 25 Feb 2003
3592 \end_layout
3593
3594 \begin_layout Subsection*
3595 LFUN_INSET_SETTINGS
3596 \end_layout
3597 \begin_layout Description
3598 Action Open the inset's properties dialog.
3599 \end_layout
3600 \begin_layout Description
3601 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.
3602 \end_layout
3603 \begin_layout Description
3604 Syntax inset-settings <INSET>
3605 \end_layout
3606 \begin_layout Description
3607 Params <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
3608 \begin_inset Newline newline
3609 \end_inset
3610
3611 graphics|href|include|index|index_print|label|line| listings|note|phantom|ref|space|tabular|vspace|wrap>.
3612 \end_layout
3613
3614 \begin_layout Subsection*
3615 LFUN_INSET_TOGGLE
3616 \end_layout
3617 \begin_layout Description
3618 Action Toggles the collapsable inset at cursor position, or the inset we are currently in.
3619 \end_layout
3620 \begin_layout Description
3621 Syntax inset-toggle [<ARG>]
3622 \end_layout
3623 \begin_layout Description
3624 Params <ARG>: <open|close|toggle|assign>.
3625 \begin_inset Newline newline
3626 \end_inset
3627
3628 open/close/toggle are for collapsable insets. toggle is used when no argument is given.
3629 \begin_inset Newline newline
3630 \end_inset
3631
3632 assign synchronize the branch-inset with activation status of the branch. Used for global toggling when changed activation.
3633 \end_layout
3634 \begin_layout Description
3635 Origin lasgouttes, 19 Jul 2001
3636 \end_layout
3637
3638 \begin_layout Subsection*
3639 LFUN_INSET_FORALL
3640 \end_layout
3641 \begin_layout Description
3642 Action Apply the given commands on insets of a given name.
3643 \end_layout
3644 \begin_layout Description
3645 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.
3646 \end_layout
3647 \begin_layout Description
3648 Syntax inset-forall <NAME> <LFUN-COMMAND>
3649 \begin_inset Newline newline
3650 \end_inset
3651
3652 <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.
3653 \end_layout
3654 \begin_layout Description
3655 Sample Remove all index insets:
3656 \begin_inset Newline newline
3657 \end_inset
3658
3659                    inset-forall Index delete-char-forward
3660 \begin_inset Newline newline
3661 \end_inset
3662
3663 Close all Notes (also works for a particular branch, for example):
3664 \begin_inset Newline newline
3665 \end_inset
3666
3667                    inset-forall Note inset-toggle close
3668 \begin_inset Newline newline
3669 \end_inset
3670
3671 Transform all yellow notes to comments
3672 \begin_inset Newline newline
3673 \end_inset
3674
3675                    inset-forall Note:Note inset-modify note Note Comment
3676 \begin_inset Newline newline
3677 \end_inset
3678
3679 Try to put LyX in an infinite loop if there is at least a Note:
3680 \begin_inset Newline newline
3681 \end_inset
3682
3683                    inset-forall Note char-backward
3684 \end_layout
3685 \begin_layout Description
3686 Origin lasgouttes, 27 Nov 2009
3687 \end_layout
3688
3689 \begin_layout Subsection*
3690 LFUN_GRAPHICS_RELOAD
3691 \end_layout
3692 \begin_layout Description
3693 Action Reloads the image if necessary.
3694 \end_layout
3695 \begin_layout Description
3696 Syntax graphics-reload
3697 \end_layout
3698 \begin_layout Description
3699 Origin vfr, 10 Aug 2009
3700 \end_layout
3701
3702 \begin_layout Subsection*
3703 LFUN_SET_GRAPHICS_GROUP
3704 \end_layout
3705 \begin_layout Description
3706 Action Set the group for the graphics inset on the cursor position.
3707 \end_layout
3708 \begin_layout Description
3709 Syntax set-graphics-group [<GROUP>]
3710 \end_layout
3711 \begin_layout Description
3712 Params <GROUP>: Id for an existing group. In case the Id is an empty string, the graphics inset is removed from the current group.
3713 \end_layout
3714 \begin_layout Description
3715 Origin sanda, 6 May 2008
3716 \end_layout
3717
3718 \begin_layout Subsection*
3719 LFUN_FINISHED_FORWARD
3720 \end_layout
3721 \begin_layout Description
3722 Action Moves the cursor out of the current slice, going forward.
3723 \end_layout
3724 \begin_layout Description
3725 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.
3726 \end_layout
3727
3728 \begin_layout Subsection*
3729 LFUN_FINISHED_BACKWARD
3730 \end_layout
3731 \begin_layout Description
3732 Action Moves the cursor out of the current slice, going backwards.
3733 \end_layout
3734 \begin_layout Description
3735 Notion See also LFUN_FINISHED_FORWARD.
3736 \end_layout
3737
3738 \begin_layout Subsection*
3739 LFUN_FINISHED_RIGHT
3740 \end_layout
3741 \begin_layout Description
3742 Action Moves the cursor out of the current slice, going right.
3743 \end_layout
3744 \begin_layout Description
3745 Notion See also LFUN_FINISHED_FORWARD
3746 \end_layout
3747
3748 \begin_layout Subsection*
3749 LFUN_FINISHED_LEFT
3750 \end_layout
3751 \begin_layout Description
3752 Action Moves the cursor out of the current slice, going left.
3753 \end_layout
3754 \begin_layout Description
3755 Notion See also LFUN_FINISHED_FORWARD.
3756 \end_layout
3757
3758 \begin_layout Subsection*
3759 LFUN_LANGUAGE
3760 \end_layout
3761 \begin_layout Description
3762 Action Set language from the current cursor position.
3763 \end_layout
3764 \begin_layout Description
3765 Syntax language <LANG>
3766 \end_layout
3767 \begin_layout Description
3768 Params <LANG>: Requested language. Look in lib/languages for the list.
3769 \end_layout
3770 \begin_layout Description
3771 Origin Dekel, 2 Mar 2000
3772 \end_layout
3773
3774 \begin_layout Subsection*
3775 LFUN_LABEL_GOTO
3776 \end_layout
3777 \begin_layout Description
3778 Action Goto a label.
3779 \end_layout
3780 \begin_layout Description
3781 Syntax label-goto [<LABEL>]
3782 \end_layout
3783 \begin_layout Description
3784 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.
3785 \end_layout
3786 \begin_layout Description
3787 Origin Ale, 6 Aug 1997
3788 \end_layout
3789
3790 \begin_layout Subsection*
3791 LFUN_LABEL_INSERT
3792 \end_layout
3793 \begin_layout Description
3794 Action Inserts label to text or displayed formula.
3795 \end_layout
3796 \begin_layout Description
3797 Syntax label-insert [<LABEL>]
3798 \end_layout
3799 \begin_layout Description
3800 Params <LABEL>: Requested label. If no label is given dialog requesting name will be opened.
3801 \end_layout
3802
3803 \begin_layout Subsection*
3804 LFUN_REFERENCE_NEXT
3805 \end_layout
3806 \begin_layout Description
3807 Action Go to the next label or cross-reference.
3808 \end_layout
3809 \begin_layout Description
3810 Syntax reference-next
3811 \end_layout
3812 \begin_layout Description
3813 Origin Dekel, 14 Jan 2001
3814 \end_layout
3815
3816 \begin_layout Subsection*
3817 LFUN_BOOKMARK_GOTO
3818 \end_layout
3819 \begin_layout Description
3820 Action Moves the cursor to the numbered bookmark, opening the file if necessary. Note that bookmarsk are saved per-session, not per file.
3821 \end_layout
3822 \begin_layout Description
3823 Notion Bookmark 0 has a special purpose. It is automatically set
3824 \begin_inset Newline newline
3825 \end_inset
3826
3827 1. to the paragraph you are currently editing
3828 \begin_inset Newline newline
3829 \end_inset
3830
3831 2. to the paragraph from where you are jumping to the last-edited position (jump-back feature)
3832 \begin_inset Newline newline
3833 \end_inset
3834
3835 3. when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
3836 \end_layout
3837 \begin_layout Description
3838 Syntax bookmark-goto <NUMBER>
3839 \end_layout
3840 \begin_layout Description
3841 Params <NUMBER>: the number of the bookmark to restore.
3842 \end_layout
3843 \begin_layout Description
3844 Origin Dekel, 27 January 2001
3845 \end_layout
3846
3847 \begin_layout Subsection*
3848 LFUN_BOOKMARK_SAVE
3849 \end_layout
3850 \begin_layout Description
3851 Action Save a bookmark.
3852 \end_layout
3853 \begin_layout Description
3854 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.
3855 \end_layout
3856 \begin_layout Description
3857 Syntax bookmark-save <NUMBER>
3858 \end_layout
3859 \begin_layout Description
3860 Params <NUMBER>: the number of the bookmark to save.
3861 \end_layout
3862 \begin_layout Description
3863 Origin Dekel, 27 January 2001
3864 \end_layout
3865
3866 \begin_layout Subsection*
3867 LFUN_BOOKMARK_CLEAR
3868 \end_layout
3869 \begin_layout Description
3870 Action Clears the list of saved bookmarks.
3871 \end_layout
3872 \begin_layout Description
3873 Syntax bookmark-clear
3874 \end_layout
3875 \begin_layout Description
3876 Origin bpeng, 31 October 2006
3877 \end_layout
3878
3879 \begin_layout Subsection*
3880 LFUN_HELP_OPEN
3881 \end_layout
3882 \begin_layout Description
3883 Action Open the given help file according to the language setting.
3884 \end_layout
3885 \begin_layout Description
3886 Syntax help-open <FILE>[.lyx]
3887 \end_layout
3888 \begin_layout Description
3889 Params <FILE>: any document from (/usr/share/)doc directory.
3890 \end_layout
3891 \begin_layout Description
3892 Origin Jug, 27 Jun 1999
3893 \end_layout
3894
3895 \begin_layout Subsection*
3896 LFUN_LYX_QUIT
3897 \end_layout
3898 \begin_layout Description
3899 Action Terminates the current LyX instance.
3900 \end_layout
3901 \begin_layout Description
3902 Notion Terminates the current LyX instance, asking whether to save modified documents, etc.
3903 \end_layout
3904 \begin_layout Description
3905 Syntax lyx-quit
3906 \end_layout
3907
3908 \begin_layout Subsection*
3909 LFUN_TOOLBAR_TOGGLE
3910 \end_layout
3911 \begin_layout Description
3912 Action Toggles visibility of a given toolbar between on/off/auto.
3913 \end_layout
3914 \begin_layout Description
3915 Notion Skipping "auto" when allowauto is false.
3916 \end_layout
3917 \begin_layout Description
3918 Syntax toolbar-toggle <NAME> [allowauto]
3919 \end_layout
3920 \begin_layout Description
3921 Params <NAME>: standard|extra|table|math|mathmacrotemplate|
3922 \begin_inset Newline newline
3923 \end_inset
3924
3925 minibuffer|review|view/update|math_panels|vcs| view-others|update-others
3926 \end_layout
3927 \begin_layout Description
3928 Origin Edwin, 21 May 2007
3929 \end_layout
3930
3931 \begin_layout Subsection*
3932 LFUN_MENU_OPEN
3933 \end_layout
3934 \begin_layout Description
3935 Action Opens the menu given by its name.
3936 \end_layout
3937 \begin_layout Description
3938 Syntax menu-open <NAME>
3939 \end_layout
3940 \begin_layout Description
3941 Params <NAME>: menu name. See various .inc files in lib/ui for candidates.
3942 \end_layout
3943
3944 \begin_layout Subsection*
3945 LFUN_UI_TOGGLE
3946 \end_layout
3947 \begin_layout Description
3948 Action Various UI visibility-toggling actions.
3949 \end_layout
3950 \begin_layout Description
3951 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
3952 \end_layout
3953 \begin_layout Description
3954 Params statusbar  : Toggle visibility of the statusbar.
3955 \begin_inset Newline newline
3956 \end_inset
3957
3958 menubar    : Toggle visibility of the menubar.
3959 \begin_inset Newline newline
3960 \end_inset
3961
3962 scrollbar  : Toggle visibility of the scrollbar.
3963 \begin_inset Newline newline
3964 \end_inset
3965
3966 frame      : Toggle visibility of the frames around editing window.
3967 \begin_inset Newline newline
3968 \end_inset
3969
3970 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.
3971 \end_layout
3972 \begin_layout Description
3973 Origin sanda, 9 Feb 2007
3974 \end_layout
3975
3976 \begin_layout Subsection*
3977 LFUN_WINDOW_NEW
3978 \end_layout
3979 \begin_layout Description
3980 Action Creates new empty LyX window.
3981 \end_layout
3982 \begin_layout Description
3983 Notion Already opened documents from the previous window can be found under View menu.
3984 \end_layout
3985 \begin_layout Description
3986 Syntax window-new [<GEOMETRY>]
3987 \end_layout
3988 \begin_layout Description
3989 Params <GEOMETRY>: pass the geometry of the window. This parameter is currently accepted only on Windows platform.
3990 \end_layout
3991 \begin_layout Description
3992 Origin Abdel, 21 Oct 2006
3993 \end_layout
3994
3995 \begin_layout Subsection*
3996 LFUN_WINDOW_CLOSE
3997 \end_layout
3998 \begin_layout Description
3999 Action Closes the current LyX window.
4000 \end_layout
4001 \begin_layout Description
4002 Syntax window-close
4003 \end_layout
4004 \begin_layout Description
4005 Origin Abdel, 23 Oct 2006
4006 \end_layout
4007
4008 \begin_layout Subsection*
4009 LFUN_SPLIT_VIEW
4010 \end_layout
4011 \begin_layout Description
4012 Action Creates another split view of current buffer.
4013 \end_layout
4014 \begin_layout Description
4015 Notion All split views act in the same way indpendently.
4016 \end_layout
4017 \begin_layout Description
4018 Syntax split-view <vertical|horizontal>
4019 \end_layout
4020 \begin_layout Description
4021 Params horizontal : The work areas are laid out side by side.
4022 \begin_inset Newline newline
4023 \end_inset
4024
4025 vertical   : The work areas laid out vertically.
4026 \end_layout
4027 \begin_layout Description
4028 Origin Abdel, 20 Feb 2008
4029 \end_layout
4030
4031 \begin_layout Subsection*
4032 LFUN_CLOSE_TAB_GROUP
4033 \end_layout
4034 \begin_layout Description
4035 Action Close the current tab group.
4036 \end_layout
4037 \begin_layout Description
4038 Notion This only closes the work areas, not the buffer themselves. The still opened buffers can be visualized in another tab group.
4039 \end_layout
4040 \begin_layout Description
4041 Syntax close-tab-group
4042 \end_layout
4043 \begin_layout Description
4044 Origin Abdel, 21 Feb 2008
4045 \end_layout
4046
4047 \begin_layout Subsection*
4048 LFUN_DIALOG_SHOW
4049 \end_layout
4050 \begin_layout Description
4051 Action Shows hidden dialog or create new one for a given function/inset settings etc.
4052 \end_layout
4053 \begin_layout Description
4054 Syntax dialog-show <NAME> [<DATA>]
4055 \end_layout
4056 \begin_layout Description
4057 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
4058 \begin_inset Newline newline
4059 \end_inset
4060
4061 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|
4062 \begin_inset Newline newline
4063 \end_inset
4064
4065 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|
4066 \begin_inset Newline newline
4067 \end_inset
4068
4069 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|
4070 \begin_inset Newline newline
4071 \end_inset
4072
4073 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|
4074 \begin_inset Newline newline
4075 \end_inset
4076
4077 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL>
4078 \begin_inset Newline newline
4079 \end_inset
4080
4081 <SPECIAL>: latexlog|vclog
4082 \begin_inset Newline newline
4083 \end_inset
4084
4085 <DATA>: data, usually settings for the given dialog. Use debug mode for the details.
4086 \end_layout
4087 \begin_layout Description
4088 Origin leeming, 17 Jun 2003
4089 \end_layout
4090
4091 \begin_layout Subsection*
4092 LFUN_DIALOG_SHOW_NEW_INSET
4093 \end_layout
4094 \begin_layout Description
4095 Action Shows hidden dialog or create new one for a given inset settings etc.
4096 \end_layout
4097 \begin_layout Description
4098 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given inset.
4099 \end_layout
4100 \begin_layout Description
4101 Syntax dialog-show-new-inset <NAME> [<DATA>]
4102 \end_layout
4103 \begin_layout Description
4104 Params See LFUN_DIALOG_SHOW .
4105 \end_layout
4106 \begin_layout Description
4107 Origin leeming, 25 Feb 2003
4108 \end_layout
4109
4110 \begin_layout Subsection*
4111 LFUN_DIALOG_UPDATE
4112 \end_layout
4113 \begin_layout Description
4114 Action Updates the dialog values from the inset/paragraph/document.
4115 \end_layout
4116 \begin_layout Description
4117 Syntax dialog-update <NAME>
4118 \end_layout
4119 \begin_layout Description
4120 Params <NAME>: paragraph|prefs|<INSET>
4121 \begin_inset Newline newline
4122 \end_inset
4123
4124 <INSET>: inset name
4125 \end_layout
4126 \begin_layout Description
4127 Origin leeming, 25 Feb 2003
4128 \end_layout
4129
4130 \begin_layout Subsection*
4131 LFUN_DIALOG_HIDE
4132 \end_layout
4133 \begin_layout Description
4134 Action Hides showed dialog. Counterpart to LFUN_DIALOG_SHOW .
4135 \end_layout
4136 \begin_layout Description
4137 Syntax dialog-hide <NAME>
4138 \end_layout
4139 \begin_layout Description
4140 Params See LFUN_DIALOG_SHOW .
4141 \end_layout
4142 \begin_layout Description
4143 Origin leeming, 25 Feb 2003
4144 \end_layout
4145
4146 \begin_layout Subsection*
4147 LFUN_DIALOG_TOGGLE
4148 \end_layout
4149 \begin_layout Description
4150 Action Toggles dialog between showed/hidden state.
4151 \end_layout
4152 \begin_layout Description
4153 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
4154 \end_layout
4155 \begin_layout Description
4156 Syntax dialog-toggle <NAME> [<DATA>]
4157 \end_layout
4158 \begin_layout Description
4159 Params See LFUN_DIALOG_SHOW .
4160 \end_layout
4161 \begin_layout Description
4162 Origin JSpitzm, 30 Apr 2007
4163 \end_layout
4164
4165 \begin_layout Subsection*
4166 LFUN_DIALOG_DISCONNECT_INSET
4167 \end_layout
4168 \begin_layout Description
4169 Action Closes opened connection to opened inset.
4170 \end_layout
4171 \begin_layout Description
4172 Notion Connection is used for apply functions.
4173 \end_layout
4174 \begin_layout Description
4175 Syntax dialog-disconnect-inset <INSET-NAME>
4176 \end_layout
4177 \begin_layout Description
4178 Origin leeming, 25 Feb 2003
4179 \end_layout
4180
4181 \begin_layout Subsection*
4182 LFUN_MOUSE_PRESS
4183 \end_layout
4184 \begin_layout Description
4185 Action This function is called when mouse button is pressed (inside workarea). Action depends on the context.
4186 \end_layout
4187 \begin_layout Description
4188 Notion This is internal LFUN, not to be used by users.
4189 \end_layout
4190 \begin_layout Description
4191 Origin Andre, 9 Aug 2002
4192 \end_layout
4193
4194 \begin_layout Subsection*
4195 LFUN_MOUSE_DOUBLE
4196 \end_layout
4197 \begin_layout Description
4198 Action This function is called when double click on mouse button is pressed (inside workarea). Action depends on the context.
4199 \end_layout
4200 \begin_layout Description
4201 Notion This is internal LFUN, not to be used by users.
4202 \end_layout
4203 \begin_layout Description
4204 Origin Andre, 9 Aug 2002
4205 \end_layout
4206
4207 \begin_layout Subsection*
4208 LFUN_MOUSE_TRIPLE
4209 \end_layout
4210 \begin_layout Description
4211 Action This function is called when triple click on mouse button is pressed (inside workarea). Action depends on the context.
4212 \end_layout
4213 \begin_layout Description
4214 Notion This is internal LFUN, not to be used by users.
4215 \end_layout
4216 \begin_layout Description
4217 Origin Andre, 9 Aug 2002
4218 \end_layout
4219
4220 \begin_layout Subsection*
4221 LFUN_MOUSE_MOTION
4222 \end_layout
4223 \begin_layout Description
4224 Action This function is called when mouse cursor is moving over the text. Action depends on the context.
4225 \end_layout
4226 \begin_layout Description
4227 Notion This is internal LFUN, not to be used by users.
4228 \end_layout
4229 \begin_layout Description
4230 Origin Andre, 9 Aug 2002
4231 \end_layout
4232
4233 \begin_layout Subsection*
4234 LFUN_MOUSE_RELEASE
4235 \end_layout
4236 \begin_layout Description
4237 Action This function is called when mouse button is released (inside workarea). Action depends on the context.
4238 \end_layout
4239 \begin_layout Description
4240 Notion This is internal LFUN, not to be used by users.
4241 \end_layout
4242 \begin_layout Description
4243 Origin Andre, 9 Aug 2002
4244 \end_layout
4245
4246 \begin_layout Subsection*
4247 LFUN_KEYMAP_OFF
4248 \end_layout
4249 \begin_layout Description
4250 Action Turn off the loaded keyboard map.
4251 \end_layout
4252 \begin_layout Description
4253 Syntax keymap-off
4254 \end_layout
4255
4256 \begin_layout Subsection*
4257 LFUN_KEYMAP_PRIMARY
4258 \end_layout
4259 \begin_layout Description
4260 Action Turn on the primary keyboard map.
4261 \end_layout
4262 \begin_layout Description
4263 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.
4264 \begin_inset Newline newline
4265 \end_inset
4266
4267 The language is to be set in the Preferences dialog.
4268 \end_layout
4269 \begin_layout Description
4270 Syntax keymap-primary
4271 \end_layout
4272
4273 \begin_layout Subsection*
4274 LFUN_KEYMAP_SECONDARY
4275 \end_layout
4276 \begin_layout Description
4277 Action Turn on the secondary keyboard map.
4278 \end_layout
4279 \begin_layout Description
4280 Syntax keymap-secondary
4281 \end_layout
4282
4283 \begin_layout Subsection*
4284 LFUN_KEYMAP_TOGGLE
4285 \end_layout
4286 \begin_layout Description
4287 Action Toggles keyboard maps (first/second/off).
4288 \end_layout
4289 \begin_layout Description
4290 Syntax keymap-toggle
4291 \end_layout
4292 \begin_layout Description
4293 Origin leeming, 30 Mar 2004
4294 \end_layout
4295
4296 \begin_layout Subsection*
4297 LFUN_SERVER_GET_LAYOUT
4298 \end_layout
4299 \begin_layout Description
4300 Action Returns the current layout (that is environment) name on the cursor position.
4301 \end_layout
4302 \begin_layout Description
4303 Syntax server-get-layout
4304 \end_layout
4305
4306 \begin_layout Subsection*
4307 LFUN_SERVER_GET_FILENAME
4308 \end_layout
4309 \begin_layout Description
4310 Action Returns path and file name of the currently edited document.
4311 \end_layout
4312 \begin_layout Description
4313 Syntax server-get-filename
4314 \end_layout
4315
4316 \begin_layout Subsection*
4317 LFUN_SERVER_GOTO_FILE_ROW
4318 \end_layout
4319 \begin_layout Description
4320 Action Sets the cursor position in LyX based on the row number of generated TeX file.
4321 \end_layout
4322 \begin_layout Description
4323 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).
4324 \end_layout
4325 \begin_layout Description
4326 Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
4327 \end_layout
4328 \begin_layout Description
4329 Params <FILE>: the path and 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.
4330 \begin_inset Newline newline
4331 \end_inset
4332
4333 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).
4334 \begin_inset Newline newline
4335 \end_inset
4336
4337 .ext: extensions will be automatically replaced by .lyx.
4338 \begin_inset Newline newline
4339 \end_inset
4340
4341 <ROW_NUMBER> The row number of the LaTeX file to which to go.
4342 \end_layout
4343 \begin_layout Description
4344 Sample server-goto-file-row /home/user/example.lyx 41
4345 \begin_inset Newline newline
4346 \end_inset
4347
4348 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
4349 \end_layout
4350 \begin_layout Description
4351 Origin Edmar, 23 Dec 1998
4352 \end_layout
4353
4354 \begin_layout Subsection*
4355 LFUN_FORWARD_SEARCH
4356 \end_layout
4357 \begin_layout Description
4358 Action Sets the cursor position in the previewed (dvi/pdf) file based on the row number in LyX window.
4359 \end_layout
4360 \begin_layout Description
4361 Notion The external program used for forward search call can be specified in LyX Output preferences. See Additional manual for details of these                settings.
4362 \end_layout
4363 \begin_layout Description
4364 Syntax forward-search
4365 \end_layout
4366 \begin_layout Description
4367 Origin sanda, 14 Apr 2010
4368 \end_layout
4369
4370 \begin_layout Subsection*
4371 LFUN_SERVER_NOTIFY
4372 \end_layout
4373 \begin_layout Description
4374 Action Sends notify message about the last key-sequence to client.
4375 \end_layout
4376 \begin_layout Description
4377 Notion This can be used to grab last key-sequence used inside the LyX window. See also Debug extensions section in Additional features manual.
4378 \end_layout
4379 \begin_layout Description
4380 Syntax server-notify
4381 \end_layout
4382
4383 \begin_layout Subsection*
4384 LFUN_SERVER_SET_XY
4385 \end_layout
4386 \begin_layout Description
4387 Action Sets the cursor position based on the editing area coordinates (similar as clicking on that point with left mouse button).
4388 \end_layout
4389 \begin_layout Description
4390 Syntax server-set-xy <X> <Y>
4391 \end_layout
4392
4393 \begin_layout Subsection*
4394 LFUN_SERVER_GET_XY
4395 \end_layout
4396 \begin_layout Description
4397 Action Returns the coordinates of cursor position in the editing area.
4398 \end_layout
4399 \begin_layout Description
4400 Syntax server-get-xy
4401 \end_layout
4402
4403 \begin_layout Subsection*
4404 LFUN_BUILD_PROGRAM
4405 \end_layout
4406 \begin_layout Description
4407 Action Generates the code (literate programming).
4408 \end_layout
4409 \begin_layout Description
4410 Notion Latex file with extension
4411 \backslash
4412 literate_extension is generated. Then LyX invokes
4413 \backslash
4414 build_command (with a default of``make'') to generate the code and
4415 \backslash
4416 build_error_filter to process the compilation error messages.
4417 \begin_inset Newline newline
4418 \end_inset
4419
4420 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:
4421 \begin_inset Newline newline
4422 \end_inset
4423
4424
4425 \backslash
4426 build_command "my_script my_arguments"
4427 \begin_inset Newline newline
4428 \end_inset
4429
4430 The
4431 \backslash
4432 build_error_filter differs from the
4433 \backslash
4434 literate_error_filter only in that the former will identify error messages from your compiler.
4435 \end_layout
4436 \begin_layout Description
4437 Syntax build-program
4438 \end_layout
4439
4440 \begin_layout Subsection*
4441 LFUN_BUFFER_AUTO_SAVE
4442 \end_layout
4443 \begin_layout Description
4444 Action Saves the current buffer to a temporary file.
4445 \end_layout
4446 \begin_layout Description
4447 Notion Saves the current buffer to a file named "#filename#". This LFUN is called automatically by LyX, to "autosave" the current buffer.
4448 \end_layout
4449 \begin_layout Description
4450 Syntax buffer-auto-save
4451 \end_layout
4452
4453 \begin_layout Subsection*
4454 LFUN_BUFFER_CHILD_OPEN
4455 \end_layout
4456 \begin_layout Description
4457 Action Loads the given child document.
4458 \end_layout
4459 \begin_layout Description
4460 Notion The current document is treated as a parent.
4461 \end_layout
4462 \begin_layout Description
4463 Syntax buffer-child-open <FILE>
4464 \end_layout
4465 \begin_layout Description
4466 Params <FILE>: Filename of the child. The directory of the parent is assumed by default.
4467 \end_layout
4468 \begin_layout Description
4469 Origin Ale, 28 May 1997
4470 \end_layout
4471
4472 \begin_layout Subsection*
4473 LFUN_BUFFER_CHKTEX
4474 \end_layout
4475 \begin_layout Description
4476 Action Runs chktex for the current document.
4477 \end_layout
4478 \begin_layout Description
4479 Syntax buffer-chktex
4480 \end_layout
4481 \begin_layout Description
4482 Origin Asger, 30 Oct 1997
4483 \end_layout
4484
4485 \begin_layout Subsection*
4486 LFUN_BUFFER_TOGGLE_COMPRESSION
4487 \end_layout
4488 \begin_layout Description
4489 Action Toggles compression of the current document on/off.
4490 \end_layout
4491 \begin_layout Description
4492 Syntax buffer-toggle-compression
4493 \end_layout
4494 \begin_layout Description
4495 Origin bpeng, 27 Apr 2006
4496 \end_layout
4497
4498 \begin_layout Subsection*
4499 LFUN_BUFFER_TOGGLE_OUTPUT_SYNC
4500 \end_layout
4501 \begin_layout Description
4502 Action Toggles including of resources for forward/reverse search of the given document.
4503 \end_layout
4504 \begin_layout Description
4505 Notion When toggled on, SyncTeX is invoked for PDF, while srcltx package is used for DVI. Custom LaTeX macro can be defined in preferences.
4506 \end_layout
4507 \begin_layout Description
4508 Syntax buffer-toggle-output-sync
4509 \end_layout
4510 \begin_layout Description
4511 Origin sanda, 25 May 2010
4512 \end_layout
4513
4514 \begin_layout Subsection*
4515 LFUN_BUFFER_CLOSE
4516 \end_layout
4517 \begin_layout Description
4518 Action Closes the current buffer.
4519 \end_layout
4520 \begin_layout Description
4521 Notion Closes the current buffer, asking whether to save it, etc, if the buffer has been modified.
4522 \end_layout
4523 \begin_layout Description
4524 Syntax buffer-close
4525 \end_layout
4526
4527 \begin_layout Subsection*
4528 LFUN_BUFFER_CLOSE_ALL
4529 \end_layout
4530 \begin_layout Description
4531 Action Closes all buffers.
4532 \end_layout
4533 \begin_layout Description
4534 Notion Closes all buffers, asking whether to save it, etc, if a buffer has been modified.
4535 \end_layout
4536 \begin_layout Description
4537 Syntax buffer-close-all
4538 \end_layout
4539
4540 \begin_layout Subsection*
4541 LFUN_BUFFER_EXPORT
4542 \end_layout
4543 \begin_layout Description
4544 Action Exports the current buffer (document) to the given format.
4545 \end_layout
4546 \begin_layout Description
4547 Syntax buffer-export <FORMAT>
4548 \end_layout
4549 \begin_layout Description
4550 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.
4551 \begin_inset Newline newline
4552 \end_inset
4553
4554 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.
4555 \end_layout
4556 \begin_layout Description
4557 Origin Lgb, 29 Jul 1997
4558 \end_layout
4559
4560 \begin_layout Subsection*
4561 LFUN_BUFFER_EXPORT_CUSTOM
4562 \end_layout
4563 \begin_layout Description
4564 Action Exports the current buffer (document) from the given format using the given command on it.
4565 \end_layout
4566 \begin_layout Description
4567 Syntax buffer-export-custom <FORMAT> <COMMAND>
4568 \end_layout
4569 \begin_layout Description
4570 Params <FORMAT> format to start from (LyX will care to produce such intermediate file).
4571 \begin_inset Newline newline
4572 \end_inset
4573
4574 <COMMAND> this command will be launched on the file. Note that you can use "$$FName" string to qualify the intermediate file.
4575 \end_layout
4576 \begin_layout Description
4577 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
4578 \end_layout
4579 \begin_layout Description
4580 Origin leeming, 27 Mar 2004
4581 \end_layout
4582
4583 \begin_layout Subsection*
4584 LFUN_BUFFER_PRINT
4585 \end_layout
4586 \begin_layout Description
4587 Action Prints the current document.
4588 \end_layout
4589 \begin_layout Description
4590 Notion Many settings can be given via the preferences dialog.
4591 \end_layout
4592 \begin_layout Description
4593 Syntax buffer-print <TARGET> <TARGET-NAME> <COMMAND>
4594 \end_layout
4595 \begin_layout Description
4596 Params <TARGET> is either "printer" or "file".
4597 \begin_inset Newline newline
4598 \end_inset
4599
4600 <TARGER-NAME> is either "default" or file name or printer name.
4601 \begin_inset Newline newline
4602 \end_inset
4603
4604 <COMMAND> command ensuring the printing job.
4605 \end_layout
4606 \begin_layout Description
4607 Sample buffer-print file "/trash/newfile1.ps" "dvips"
4608 \end_layout
4609 \begin_layout Description
4610 Origin leeming, 28 Mar 2004
4611 \end_layout
4612
4613 \begin_layout Subsection*
4614 LFUN_BUFFER_IMPORT
4615 \end_layout
4616 \begin_layout Description
4617 Action Import a given file as a lyx document.
4618 \end_layout
4619 \begin_layout Description
4620 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.
4621 \end_layout
4622 \begin_layout Description
4623 Syntax buffer-import <FORMAT> [<FILE>]
4624 \end_layout
4625 \begin_layout Description
4626 Origin Asger, 24 Jul 1998
4627 \end_layout
4628
4629 \begin_layout Subsection*
4630 LFUN_BUFFER_NEW
4631 \end_layout
4632 \begin_layout Description
4633 Action Creates a new buffer (that is, document).
4634 \end_layout
4635 \begin_layout Description
4636 Notion Implicit path can be set in Preferences dialog.
4637 \end_layout
4638 \begin_layout Description
4639 Syntax buffer-new [<FILE>]
4640 \end_layout
4641 \begin_layout Description
4642 Params <FILE>: filename of created file with absolute path.
4643 \end_layout
4644
4645 \begin_layout Subsection*
4646 LFUN_BUFFER_NEW_TEMPLATE
4647 \end_layout
4648 \begin_layout Description
4649 Action Creates a new buffer (that is, document) from a template.
4650 \end_layout
4651 \begin_layout Description
4652 Notion Path for new files and templates can be set in Preferences dialog. Template will be asked for via Open-dialog.
4653 \end_layout
4654 \begin_layout Description
4655 Syntax buffer-new-template [<FILE>]
4656 \end_layout
4657 \begin_layout Description
4658 Params <FILE>: filename of created file with absolute path.
4659 \end_layout
4660
4661 \begin_layout Subsection*
4662 LFUN_BUFFER_RELOAD
4663 \end_layout
4664 \begin_layout Description
4665 Action Reverts opened document.
4666 \end_layout
4667 \begin_layout Description
4668 Syntax buffer-reload
4669 \end_layout
4670 \begin_layout Description
4671 Origin Asger, 2 Feb 1997
4672 \end_layout
4673
4674 \begin_layout Subsection*
4675 LFUN_BUFFER_SWITCH
4676 \end_layout
4677 \begin_layout Description
4678 Action Display/switch to the given buffer.
4679 \end_layout
4680 \begin_layout Description
4681 Syntax buffer-switch <BUFFER>
4682 \end_layout
4683 \begin_layout Description
4684 Params <BUFFER>: path and filename of already opened (but possibly hidden) document which is to be shown.
4685 \end_layout
4686
4687 \begin_layout Subsection*
4688 LFUN_BUFFER_TOGGLE_READ_ONLY
4689 \end_layout
4690 \begin_layout Description
4691 Action Toggle editing mode of the current document between read/write and read-only.
4692 \end_layout
4693 \begin_layout Description
4694 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.
4695 \end_layout
4696 \begin_layout Description
4697 Syntax buffer-toggle-read-only
4698 \end_layout
4699 \begin_layout Description
4700 Origin Lgb, 27 May 1997
4701 \end_layout
4702
4703 \begin_layout Subsection*
4704 LFUN_BUFFER_VIEW
4705 \end_layout
4706 \begin_layout Description
4707 Action Displays current buffer in chosen format.
4708 \end_layout
4709 \begin_layout Description
4710 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.
4711 \end_layout
4712 \begin_layout Description
4713 Syntax buffer-view [<FORMAT>]
4714 \end_layout
4715 \begin_layout Description
4716 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.
4717 \end_layout
4718
4719 \begin_layout Subsection*
4720 LFUN_BUFFER_UPDATE
4721 \end_layout
4722 \begin_layout Description
4723 Action Exports the current document and put the result into the temporary directory.
4724 \end_layout
4725 \begin_layout Description
4726 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).
4727 \end_layout
4728 \begin_layout Description
4729 Syntax buffer-update [<FORMAT>]
4730 \end_layout
4731 \begin_layout Description
4732 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.
4733 \end_layout
4734 \begin_layout Description
4735 Origin Dekel, 5 Aug 2000
4736 \end_layout
4737
4738 \begin_layout Subsection*
4739 LFUN_BUFFER_WRITE
4740 \end_layout
4741 \begin_layout Description
4742 Action Saves the current buffer.
4743 \end_layout
4744 \begin_layout Description
4745 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.
4746 \end_layout
4747 \begin_layout Description
4748 Syntax buffer-write
4749 \end_layout
4750
4751 \begin_layout Subsection*
4752 LFUN_BUFFER_WRITE_AS
4753 \end_layout
4754 \begin_layout Description
4755 Action Rename and save current buffer.
4756 \end_layout
4757 \begin_layout Description
4758 Syntax buffer-write-as <FILENAME>
4759 \end_layout
4760 \begin_layout Description
4761 Params <FILENAME>: New name of the buffer/file. A relative path is with respect to the original location of the buffer/file.
4762 \end_layout
4763
4764 \begin_layout Subsection*
4765 LFUN_BUFFER_WRITE_ALL
4766 \end_layout
4767 \begin_layout Description
4768 Action Save all changed documents.
4769 \end_layout
4770 \begin_layout Description
4771 Syntax buffer-write-all
4772 \end_layout
4773 \begin_layout Description
4774 Origin rgh, gpothier 6 Aug 2007
4775 \end_layout
4776
4777 \begin_layout Subsection*
4778 LFUN_BUFFER_NEXT
4779 \end_layout
4780 \begin_layout Description
4781 Action Switch to the next opened document.
4782 \end_layout
4783 \begin_layout Description
4784 Notion Note that this does not necessarily mean next in tabbar (for full list see View menu).
4785 \end_layout
4786 \begin_layout Description
4787 Syntax buffer-next
4788 \end_layout
4789
4790 \begin_layout Subsection*
4791 LFUN_BUFFER_PREVIOUS
4792 \end_layout
4793 \begin_layout Description
4794 Action Switch to the previous opened document.
4795 \end_layout
4796 \begin_layout Description
4797 Syntax buffer-previous
4798 \end_layout
4799
4800 \begin_layout Subsection*
4801 LFUN_MASTER_BUFFER_UPDATE
4802 \end_layout
4803 \begin_layout Description
4804 Action When run from a child document, this updates (exports) document built from the master buffer, if available.
4805 \end_layout
4806 \begin_layout Description
4807 Syntax master-buffer-update [<FORMAT>]
4808 \end_layout
4809 \begin_layout Description
4810 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.
4811 \end_layout
4812 \begin_layout Description
4813 Origin Tommaso, 20 Sep 2007
4814 \end_layout
4815
4816 \begin_layout Subsection*
4817 LFUN_MASTER_BUFFER_VIEW
4818 \end_layout
4819 \begin_layout Description
4820 Action When run from a child document, this command shows a preview built from the master buffer, if available.
4821 \end_layout
4822 \begin_layout Description
4823 Syntax master-buffer-view [<FORMAT>]
4824 \end_layout
4825 \begin_layout Description
4826 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.
4827 \end_layout
4828 \begin_layout Description
4829 Origin Tommaso, 20 Sep 2007
4830 \end_layout
4831
4832 \begin_layout Subsection*
4833 LFUN_BUFFER_LANGUAGE
4834 \end_layout
4835 \begin_layout Description
4836 Action Set language of the current document.
4837 \end_layout
4838 \begin_layout Description
4839 Syntax buffer-language <LANG>
4840 \end_layout
4841 \begin_layout Description
4842 Params <LANG>: language name. See lib/languages for list.
4843 \end_layout
4844 \begin_layout Description
4845 Origin leeming, 30 Mar 2004
4846 \end_layout
4847
4848 \begin_layout Subsection*
4849 LFUN_BUFFER_SAVE_AS_DEFAULT
4850 \end_layout
4851 \begin_layout Description
4852 Action Save the current document settings as default.
4853 \end_layout
4854 \begin_layout Description
4855 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
4856 \end_layout
4857 \begin_layout Description
4858 Syntax buffer-save-as-default [<ARGS>]
4859 \end_layout
4860 \begin_layout Description
4861 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
4862 \end_layout
4863 \begin_layout Description
4864 Origin leeming, 30 Mar 2004
4865 \end_layout
4866
4867 \begin_layout Subsection*
4868 LFUN_BUFFER_PARAMS_APPLY
4869 \end_layout
4870 \begin_layout Description
4871 Action Apply the given settings to the current document.
4872 \end_layout
4873 \begin_layout Description
4874 Syntax buffer-params-apply [<ARGS>]
4875 \end_layout
4876 \begin_layout Description
4877 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
4878 \end_layout
4879 \begin_layout Description
4880 Origin leeming, 30 Mar 2004
4881 \end_layout
4882
4883 \begin_layout Subsection*
4884 LFUN_FILE_INSERT
4885 \end_layout
4886 \begin_layout Description
4887 Action Inserts another LyX file.
4888 \end_layout
4889 \begin_layout Description
4890 Syntax file-insert [<FILE>]
4891 \end_layout
4892 \begin_layout Description
4893 Params <FILE>: Filename to be inserted.
4894 \end_layout
4895
4896 \begin_layout Subsection*
4897 LFUN_FILE_INSERT_PLAINTEXT
4898 \end_layout
4899 \begin_layout Description
4900 Action Inserts plain text file.
4901 \end_layout
4902 \begin_layout Description
4903 Syntax file-insert-plaintext [<FILE>]
4904 \end_layout
4905 \begin_layout Description
4906 Params <FILE>: Filename to be inserted.
4907 \end_layout
4908 \begin_layout Description
4909 Origin CFO-G, 19 Nov 1997
4910 \end_layout
4911
4912 \begin_layout Subsection*
4913 LFUN_FILE_INSERT_PLAINTEXT_PARA
4914 \end_layout
4915 \begin_layout Description
4916 Action Inserts plain text file as paragraph (i.e. join lines).
4917 \end_layout
4918 \begin_layout Description
4919 Syntax file-insert-plaintext-para [<FILE>]
4920 \end_layout
4921 \begin_layout Description
4922 Params <FILE>: Filename to be inserted.
4923 \end_layout
4924 \begin_layout Description
4925 Origin Levon, 14 Feb 2001
4926 \end_layout
4927
4928 \begin_layout Subsection*
4929 LFUN_FILE_OPEN
4930 \end_layout
4931 \begin_layout Description
4932 Action Open LyX document.
4933 \end_layout
4934 \begin_layout Description
4935 Syntax file-open [<FILE>]
4936 \end_layout
4937 \begin_layout Description
4938 Params <FILE>: Filename to be opened.
4939 \end_layout
4940
4941 \begin_layout Subsection*
4942 LFUN_CALL
4943 \end_layout
4944 \begin_layout Description
4945 Action Executes a command defined in a .def file.
4946 \end_layout
4947 \begin_layout Description
4948 Notion The definitions are by default read from lib/commands/default.def.
4949 \begin_inset Newline newline
4950 \end_inset
4951
4952 A .def file allows to define a command with
4953 \backslash
4954 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).
4955 \backslash
4956 def_file "FileName" allows to include another .def file.
4957 \begin_inset Newline newline
4958 \end_inset
4959
4960 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.
4961 \end_layout
4962 \begin_layout Description
4963 Syntax call <NAME>
4964 \end_layout
4965 \begin_layout Description
4966 Params <NAME>: Name of the command that must be called.
4967 \end_layout
4968 \begin_layout Description
4969 Origin broider, 2 Oct 2007
4970 \end_layout
4971
4972 \begin_layout Subsection*
4973 LFUN_META_PREFIX
4974 \end_layout
4975 \begin_layout Description
4976 Action Simulate halting Meta key (Alt key on PCs).
4977 \end_layout
4978 \begin_layout Description
4979 Notion Used for buffer editation not for GUI control.
4980 \end_layout
4981 \begin_layout Description
4982 Syntax meta-prefix
4983 \end_layout
4984
4985 \begin_layout Subsection*
4986 LFUN_CANCEL
4987 \end_layout
4988 \begin_layout Description
4989 Action Cancels sequence prepared by LFUN_META_PREFIX .
4990 \end_layout
4991 \begin_layout Description
4992 Syntax cancel
4993 \end_layout
4994
4995 \begin_layout Subsection*
4996 LFUN_COMMAND_EXECUTE
4997 \end_layout
4998 \begin_layout Description
4999 Action Switches the focus to the minibuffer so that the user can type in there. If necessary, it opens the minibuffer toolbar.
5000 \end_layout
5001 \begin_layout Description
5002 Notion Usually bound to M-x shortcut.
5003 \end_layout
5004 \begin_layout Description
5005 Syntax command-execute
5006 \end_layout
5007
5008 \begin_layout Subsection*
5009 LFUN_COMMAND_PREFIX
5010 \end_layout
5011 \begin_layout Description
5012 Action Return the current key sequence and available options as a string.
5013 \end_layout
5014 \begin_layout Description
5015 Notion No options are added if no current map exists.
5016 \begin_inset Newline newline
5017 \end_inset
5018
5019 This is probably usable only with connection to lyxserver.
5020 \end_layout
5021 \begin_layout Description
5022 Syntax command-prefix
5023 \end_layout
5024
5025 \begin_layout Subsection*
5026 LFUN_COMMAND_SEQUENCE
5027 \end_layout
5028 \begin_layout Description
5029 Action Run more commands (LFUN and its parameters) in a sequence.
5030 \end_layout
5031 \begin_layout Description
5032 Syntax command-sequence <CMDS>
5033 \end_layout
5034 \begin_layout Description
5035 Params <CMDS>: Sequence of commands separated by semicolons.
5036 \end_layout
5037 \begin_layout Description
5038 Sample command-sequence cut; ert-insert; self-insert
5039 \backslash
5040 ; paste; self-insert {}; inset-toggle;
5041 \end_layout
5042 \begin_layout Description
5043 Origin Andre, 11 Nov 1999
5044 \end_layout
5045
5046 \begin_layout Subsection*
5047 LFUN_COMMAND_ALTERNATIVES
5048 \end_layout
5049 \begin_layout Description
5050 Action Runs the first listed command that is enabled.
5051 \end_layout
5052 \begin_layout Description
5053 Notion This can be used to bind multiple functions to a single key, and then which one is used will depend upon the context.
5054 \end_layout
5055 \begin_layout Description
5056 Syntax command-alternatives <CMDS>
5057 \end_layout
5058 \begin_layout Description
5059 Params <CMDS>: Sequence of commands separated by semicolons.
5060 \end_layout
5061 \begin_layout Description
5062 Sample command-alternatives completion-accept;cell-forward
5063 \end_layout
5064 \begin_layout Description
5065 Origin rgh, 24 September 2008
5066 \end_layout
5067
5068 \begin_layout Subsection*
5069 LFUN_MESSAGE
5070 \end_layout
5071 \begin_layout Description
5072 Action Shows message in statusbar (for script purposes).
5073 \end_layout
5074 \begin_layout Description
5075 Syntax message <STRING>
5076 \end_layout
5077 \begin_layout Description
5078 Origin Lgb, 8 Apr 2001
5079 \end_layout
5080
5081 \begin_layout Subsection*
5082 LFUN_DEBUG_LEVEL_SET
5083 \end_layout
5084 \begin_layout Description
5085 Action Set debug output level.
5086 \end_layout
5087 \begin_layout Description
5088 Syntax debug-level-set <LEVEL>
5089 \end_layout
5090 \begin_layout Description
5091 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.
5092 \end_layout
5093 \begin_layout Description
5094 Origin sanda, 28 Dec 2009
5095 \end_layout
5096
5097 \begin_layout Subsection*
5098 LFUN_PREFERENCES_SAVE
5099 \end_layout
5100 \begin_layout Description
5101 Action Save user preferences.
5102 \end_layout
5103 \begin_layout Description
5104 Syntax preferences-save
5105 \end_layout
5106 \begin_layout Description
5107 Origin Lgb, 27 Nov 1999
5108 \end_layout
5109
5110 \begin_layout Subsection*
5111 LFUN_RECONFIGURE
5112 \end_layout
5113 \begin_layout Description
5114 Action Reconfigure the automatic settings.
5115 \end_layout
5116 \begin_layout Description
5117 Syntax reconfigure
5118 \end_layout
5119 \begin_layout Description
5120 Origin Asger, 14 Feb 1997
5121 \end_layout
5122
5123 \begin_layout Subsection*
5124 LFUN_LYXRC_APPLY
5125 \end_layout
5126 \begin_layout Description
5127 Action Apply the given settings to user preferences.
5128 \end_layout
5129 \begin_layout Description
5130 Syntax lyxrc-apply <SETTINGS>
5131 \end_layout
5132 \begin_layout Description
5133 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.
5134 \end_layout
5135
5136 \begin_layout Subsection*
5137 LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
5138 \end_layout
5139 \begin_layout Description
5140 Action Determine whether keep cursor inside the editing window regardless the scrollbar movement.
5141 \end_layout
5142 \begin_layout Description
5143 Syntax toggle-cursor-follows-scrollbar
5144 \end_layout
5145 \begin_layout Description
5146 Origin ARRae, 2 Dec 1997
5147 \end_layout
5148
5149 \begin_layout Subsection*
5150 LFUN_SET_COLOR
5151 \end_layout
5152 \begin_layout Description
5153 Action Set the given LyX color to the color defined by the X11 name given.
5154 \end_layout
5155 \begin_layout Description
5156 Notion A new color entry is created if the color is unknown. Color names can be stored as a part of user settings.
5157 \end_layout
5158 \begin_layout Description
5159 Syntax set-color <LYX_NAME> <X11_NAME>
5160 \end_layout
5161 \begin_layout Description
5162 Origin SLior, 11 Jun 2000
5163 \end_layout
5164
5165 \begin_layout Subsection*
5166 LFUN_STATISTICS
5167 \end_layout
5168 \begin_layout Description
5169 Action Count the statistics (number of words and characters) in the document or in the given selection.
5170 \end_layout
5171 \begin_layout Description
5172 Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
5173 \end_layout
5174 \begin_layout Description
5175 Syntax statistics
5176 \end_layout
5177 \begin_layout Description
5178 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
5179 \end_layout
5180
5181 \begin_layout Subsection*
5182 LFUN_COMPLETION_INLINE
5183 \end_layout
5184 \begin_layout Description
5185 Action Show the inline completion at the cursor position.
5186 \end_layout
5187 \begin_layout Description
5188 Syntax completion-inline
5189 \end_layout
5190 \begin_layout Description
5191 Origin sts, Feb 19 2008
5192 \end_layout
5193
5194 \begin_layout Subsection*
5195 LFUN_COMPLETION_POPUP
5196 \end_layout
5197 \begin_layout Description
5198 Action Show the completion popup at the cursor position.
5199 \end_layout
5200 \begin_layout Description
5201 Syntax completion-popup
5202 \end_layout
5203 \begin_layout Description
5204 Origin sts, Feb 19 2008
5205 \end_layout
5206
5207 \begin_layout Subsection*
5208 LFUN_COMPLETION_COMPLETE
5209 \end_layout
5210 \begin_layout Description
5211 Action Try to complete the word or command at the cursor position.
5212 \end_layout
5213 \begin_layout Description
5214 Syntax complete
5215 \end_layout
5216 \begin_layout Description
5217 Origin sts, Feb 19 2008
5218 \end_layout
5219
5220 \begin_layout Subsection*
5221 LFUN_COMPLETION_CANCEL
5222 \end_layout
5223 \begin_layout Description
5224 Action Try to cancel completion, either the popup or the inline completion.
5225 \end_layout
5226 \begin_layout Description
5227 Syntax completion-cancel
5228 \end_layout
5229 \begin_layout Description
5230 Origin sts, Sep 07 2008
5231 \end_layout
5232
5233 \begin_layout Subsection*
5234 LFUN_COMPLETION_ACCEPT
5235 \end_layout
5236 \begin_layout Description
5237 Action Accept suggested completion.
5238 \end_layout
5239 \begin_layout Description
5240 Syntax completion-accept
5241 \end_layout
5242 \begin_layout Description
5243 Origin sanda, Sep 08 2008
5244 \end_layout
5245
5246 \begin_layout Subsection*
5247 LFUN_BRANCH_ADD
5248 \end_layout
5249 \begin_layout Description
5250 Action Add a branch to the buffer's BranchList.
5251 \end_layout
5252 \begin_layout Description
5253 Syntax branch-add <BRANCH>
5254 \end_layout
5255 \begin_layout Description
5256 Params <BRANCH>: Name of the branch to add
5257 \end_layout
5258 \begin_layout Description
5259 Origin spitz, 7 Jul 2009
5260 \end_layout
5261
5262 \begin_layout Subsection*
5263 LFUN_BRANCH_ACTIVATE
5264 \end_layout
5265 \begin_layout Description
5266 Action Activate the branch.
5267 \end_layout
5268 \begin_layout Description
5269 Syntax branch-activate <BRANCH>
5270 \end_layout
5271 \begin_layout Description
5272 Params <BRANCH>: The branch to activate
5273 \end_layout
5274 \begin_layout Description
5275 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
5276 \begin_inset Newline newline
5277 \end_inset
5278
5279 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
5280 \end_layout
5281 \begin_layout Description
5282 Origin rgh, 27 May 2008
5283 \end_layout
5284
5285 \begin_layout Subsection*
5286 LFUN_BRANCH_DEACTIVATE
5287 \end_layout
5288 \begin_layout Description
5289 Action De-activate the branch.
5290 \end_layout
5291 \begin_layout Description
5292 Syntax branch-deactivate <BRANCH>
5293 \end_layout
5294 \begin_layout Description
5295 Params <BRANCH>: The branch to deactivate
5296 \end_layout
5297 \begin_layout Description
5298 Origin rgh, 27 May 2008
5299 \end_layout
5300
5301 \begin_layout Subsection*
5302 LFUN_BRANCHES_RENAME
5303 \end_layout
5304 \begin_layout Description
5305 Action Rename all branches of a given name in a document.
5306 \end_layout
5307 \begin_layout Description
5308 Syntax branches-rename <OLDNAME> <NEWNAME>
5309 \end_layout
5310 \begin_layout Description
5311 Params <OLDNAME>: Current name of the branch to be renamed <NEWNAME>: New name of the branch
5312 \end_layout
5313 \begin_layout Description
5314 Origin spitz, 9 Jul 2009
5315 \end_layout
5316
5317 \begin_layout Subsection*
5318 LFUN_BRANCH_ADD_INSERT
5319 \end_layout
5320 \begin_layout Description
5321 Action Create new branch and directly put the branch inset into the document.
5322 \end_layout
5323 \begin_layout Description
5324 Syntax branch-add-insert [<NAME>]
5325 \end_layout
5326 \begin_layout Description
5327 Params <NAME>: Branch name. If it is not specified, you will be asked.
5328 \end_layout
5329 \begin_layout Description
5330 Origin sanda, 10 Jul 2009
5331 \end_layout
5332
5333 \begin_layout Subsection*
5334 LFUN_LABEL_COPY_AS_REF
5335 \end_layout
5336 \begin_layout Description
5337 Action Copies the label at the cursor as a cross-reference to be pasted elsewhere.
5338 \end_layout
5339 \begin_layout Description
5340 Syntax copy-label-as-reference <LABEL>
5341 \end_layout
5342 \begin_layout Description
5343 Params <LABEL>: The label to copy (for multi-line math)
5344 \end_layout
5345 \begin_layout Description
5346 Origin sts, 16 Nov 2008
5347 \end_layout
5348
5349 \begin_layout Subsection*
5350 LFUN_LABEL_INSERT_AS_REF
5351 \end_layout
5352 \begin_layout Description
5353 Action Inserts the label as a cross-reference at the position of the cursor.
5354 \end_layout
5355 \begin_layout Description
5356 Syntax label-insert-as-reference
5357 \end_layout
5358 \begin_layout Description
5359 Origin vfr, 7 Apr 2009
5360 \end_layout
5361
5362 \begin_layout Subsection*
5363 LFUN_BUFFER_ZOOM_IN
5364 \end_layout
5365 \begin_layout Description
5366 Action Increases the zoom of the screen fonts.
5367 \end_layout
5368 \begin_layout Description
5369 Syntax buffer-zoom-in [<ZOOM>]
5370 \end_layout
5371 \begin_layout Description
5372 Params <ZOOM>: The zoom in %, the default is 20.
5373 \end_layout
5374 \begin_layout Description
5375 Origin vfr, 30 Mar 2009
5376 \end_layout
5377
5378 \begin_layout Subsection*
5379 LFUN_BUFFER_ZOOM_OUT
5380 \end_layout
5381 \begin_layout Description
5382 Action Decreases the zoom of the screen fonts.
5383 \end_layout
5384 \begin_layout Description
5385 Syntax buffer-zoom-out [<ZOOM>]
5386 \end_layout
5387 \begin_layout Description
5388 Params <ZOOM>: The zoom in %, the default is 20.
5389 \end_layout
5390 \begin_layout Description
5391 Origin vfr, 30 Mar 2009
5392 \end_layout
5393
5394 \begin_layout Subsection*
5395 LFUN_INSET_COPY_AS
5396 \end_layout
5397 \begin_layout Description
5398 Action Copies the inset to the clipboard as a certain type.
5399 \end_layout
5400 \begin_layout Description
5401 Notion Currently used only for InsetInfo where its content is copied as a text.
5402 \end_layout
5403 \begin_layout Description
5404 Syntax inset-copy-as
5405 \end_layout
5406 \begin_layout Description
5407 Origin vfr, 18 Apr 2010
5408 \end_layout
5409
5410 \end_body
5411 \end_document