lib/doc/LFUNs.lyx

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