lib/doc/LFUNs.lyx

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