lib/doc/LFUNs.lyx

   1 #LyX 2.4 created this file. For more info see https://www.lyx.org/
   2 \lyxformat 600
   3 \begin_document
   4 \begin_header
   5 \save_transient_properties true
   6 \origin /systemlyxdir/doc/
   7 \textclass article
   8 \begin_preamble
   9 \renewcommand{\descriptionlabel}[1]{\hspace\labelsep\upshape\bfseries #1:}
  10 \renewenvironment{description}{\list{}{%
  11   \setlength{\itemsep}{-2pt}
  12   \advance\leftmargini6\p@ \itemindent-12\p@
  13   \labelwidth\z@ \let\makelabel\descriptionlabel}%
  14 }{
  15   \endlist
  16 }
  17 \end_preamble
  18 \use_default_options false
  19 \maintain_unincluded_children no
  20 \begin_local_layout
  21 Style Description
  22 LabelIndent           MM
  23 LeftMargin            MMMMMxx
  24 End
  25 \end_local_layout
  26 \language english
  27 \language_package default
  28 \inputencoding auto-legacy
  29 \fontencoding auto
  30 \font_roman "default" "default"
  31 \font_sans "default" "default"
  32 \font_typewriter "default" "default"
  33 \font_math "auto" "auto"
  34 \font_default_family default
  35 \use_non_tex_fonts false
  36 \font_sc false
  37 \font_sans_osf false
  38 \font_typewriter_osf false
  39 \font_roman_osf false
  40 \font_sf_scale 100 100
  41 \font_tt_scale 100 100
  42 \use_microtype 0
  43 \graphics default
  44 \default_output_format default
  45 \output_sync 0
  46 \bibtex_command default
  47 \index_command default
  48 \paperfontsize default
  49 \spacing single
  50 \use_hyperref false
  51 \papersize default
  52 \use_geometry true
  53 \use_package amsmath 1
  54 \use_package amssymb 1
  55 \use_package cancel 0
  56 \use_package esint 1
  57 \use_package mathdots 0
  58 \use_package mathtools 0
  59 \use_package mhchem 1
  60 \use_package stackrel 0
  61 \use_package stmaryrd 0
  62 \use_package undertilde 0
  63 \cite_engine basic
  64 \cite_engine_type default
  65 \biblio_style plain
  66 \use_bibtopic false
  67 \use_indices false
  68 \paperorientation portrait
  69 \suppress_date false
  70 \justification true
  71 \use_refstyle 0
  72 \use_minted 0
  73 \use_lineno 0
  74 \index Index
  75 \shortcut idx
  76 \color #008000
  77 \end_index
  78 \leftmargin 2.5cm
  79 \topmargin 2cm
  80 \rightmargin 3cm
  81 \bottommargin 2.5cm
  82 \secnumdepth 3
  83 \tocdepth 3
  84 \paragraph_separation indent
  85 \paragraph_indentation default
  86 \is_math_indent 0
  87 \math_numbering_side default
  88 \quotes_style english
  89 \papercolumns 1
  90 \papersides 1
  91 \paperpagestyle default
  92 \tracking_changes false
  93 \postpone_fragile_content false
  94 \output_changes false
  95 \html_math_output 0
  96 \html_css_as_file 0
  97 \html_be_strict false
  98 \end_header
  99
 100 \begin_body
 101
 102 \begin_layout Title
 103 \SpecialChar LyX
 104  Functions (LFUNs)
 105 \end_layout
 106
 107 \begin_layout Author
 108 The \SpecialChar LyX
 109  Team
 110 \end_layout
 111
 112 \begin_layout Section*
 113 About this manual
 114 \end_layout
 115
 116 \begin_layout Standard
 117 This manual documents the
 118 \begin_inset Quotes eld
 119 \end_inset
 120
 121 LyX Functions
 122 \begin_inset Quotes erd
 123 \end_inset
 124
 125  (abbreviated LFUNs).
 126  These are commands that are used to make \SpecialChar LyX
 127  perform specific actions.
 128  \SpecialChar LyX
 129  itself uses these functions internally, and every internal action is
 130  bound to an LFUN.
 131 \end_layout
 132
 133 \begin_layout Standard
 134 LFUNs are also used in the files that define keyboard shortcuts, menu or
 135  toolbar items.
 136  So if you want to change\SpecialChar breakableslash
 137 customize the user interface, you need to deal
 138  with LFUNs.
 139  Furthermore, external programs can use LFUNs to communicate with and
 140 \begin_inset Quotes eld
 141 \end_inset
 142
 143 remote-control
 144 \begin_inset Quotes erd
 145 \end_inset
 146
 147  \SpecialChar LyX
 148  .
 149  Finally, you can also issue LFUNs directly via the so called mini-buffer
 150  which can be opened via
 151 \begin_inset Info
 152 type  "shortcuts"
 153 arg   "command-execute"
 154 \end_inset
 155
 156 .
 157 \end_layout
 158
 159 \begin_layout Standard
 160 In the following, all LFUNs are listed, categorized by function.
 161 \end_layout
 162
 163 \begin_layout Section
 164 Layout Functions (Font, Layout and Textclass related)
 165 \end_layout
 166
 167 \begin_layout Subsection*
 168 drop-layouts-choice
 169 \end_layout
 170
 171 \begin_layout Description
 172 Action Displays list of layout choices.
 173 \end_layout
 174
 175 \begin_layout Description
 176 Notion This LFUN opens the dropbox allowing for choice of layout.
 177 \end_layout
 178
 179 \begin_layout Description
 180 Syntax drop-layouts-choice
 181 \end_layout
 182
 183 \begin_layout Subsection*
 184 environment-split
 185 \end_layout
 186
 187 \begin_layout Description
 188 Action Splits the current environment with a Separator.
 189 \end_layout
 190
 191 \begin_layout Description
 192 Syntax environment-split [before|outer|previous]
 193 \end_layout
 194
 195 \begin_layout Description
 196 Params outer:    If this is given, LyX will split the outermost environment in the current nesting hierarchy.
 197 \begin_inset Newline newline
 198 \end_inset
 199
 200 previous: If this is given, LyX will split the environment in the previous paragraph (if there is one).
 201 \begin_inset Newline newline
 202 \end_inset
 203
 204 before:   If this is given, the new environment will be appended rather than prepended.
 205 \end_layout
 206
 207 \begin_layout Description
 208 Origin spitz, 23 Dec 2012
 209 \end_layout
 210
 211 \begin_layout Subsection*
 212 font-bold
 213 \end_layout
 214
 215 \begin_layout Description
 216 Action Toggles the bold font (selection-wise) using mathbf in math.
 217 \end_layout
 218
 219 \begin_layout Description
 220 Syntax font-bold
 221 \end_layout
 222
 223 \begin_layout Subsection*
 224 font-boldsymbol
 225 \end_layout
 226
 227 \begin_layout Description
 228 Action Toggles the bold font (selection-wise) using boldsymbol in math.
 229 \end_layout
 230
 231 \begin_layout Description
 232 Syntax font-boldsymbol
 233 \end_layout
 234
 235 \begin_layout Subsection*
 236 font-crossout
 237 \end_layout
 238
 239 \begin_layout Description
 240 Action Toggles xout (cross-through) in the font (selection-wise).
 241 \end_layout
 242
 243 \begin_layout Description
 244 Syntax font-crossout
 245 \end_layout
 246
 247 \begin_layout Description
 248 Origin uwestoehr, 4 April 2017
 249 \end_layout
 250
 251 \begin_layout Subsection*
 252 font-default
 253 \end_layout
 254
 255 \begin_layout Description
 256 Action Reverts the settings of the font to the default values (selection-wise).
 257 \end_layout
 258
 259 \begin_layout Description
 260 Syntax font-default
 261 \end_layout
 262
 263 \begin_layout Subsection*
 264 font-emph
 265 \end_layout
 266
 267 \begin_layout Description
 268 Action Toggles the emphasis font style (selection-wise).
 269 \end_layout
 270
 271 \begin_layout Description
 272 Syntax font-emph
 273 \end_layout
 274
 275 \begin_layout Subsection*
 276 font-frak
 277 \end_layout
 278
 279 \begin_layout Description
 280 Action Toggles Fraktur family font (math-mode, selection-wise).
 281 \end_layout
 282
 283 \begin_layout Description
 284 Syntax font-frak
 285 \end_layout
 286
 287 \begin_layout Description
 288 Origin vermeer, 10 Jan 2002
 289 \end_layout
 290
 291 \begin_layout Subsection*
 292 font-ital
 293 \end_layout
 294
 295 \begin_layout Description
 296 Action Toggles Italics font shape (math-mode, selection-wise).
 297 \end_layout
 298
 299 \begin_layout Description
 300 Syntax font-ital
 301 \end_layout
 302
 303 \begin_layout Description
 304 Origin vermeer, 10 Jan 2002
 305 \end_layout
 306
 307 \begin_layout Subsection*
 308 font-noun
 309 \end_layout
 310
 311 \begin_layout Description
 312 Action Toggles Noun text style font (selection-wise).
 313 \end_layout
 314
 315 \begin_layout Description
 316 Syntax font-noun
 317 \end_layout
 318
 319 \begin_layout Subsection*
 320 font-roman
 321 \end_layout
 322
 323 \begin_layout Description
 324 Action Toggles Roman family font (selection-wise).
 325 \end_layout
 326
 327 \begin_layout Description
 328 Syntax font-roman
 329 \end_layout
 330
 331 \begin_layout Subsection*
 332 font-sans
 333 \end_layout
 334
 335 \begin_layout Description
 336 Action Toggles Sans Serif family font (selection-wise).
 337 \end_layout
 338
 339 \begin_layout Description
 340 Syntax font-sans
 341 \end_layout
 342
 343 \begin_layout Subsection*
 344 font-size
 345 \end_layout
 346
 347 \begin_layout Description
 348 Action Sets font size according to lyx format string.
 349 \end_layout
 350
 351 \begin_layout Description
 352 Syntax font-size <SIZE>
 353 \end_layout
 354
 355 \begin_layout Description
 356 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
 357 \begin_inset Newline newline
 358 \end_inset
 359
 360 largest|huge|giant|increase|decrease|default
 361 \end_layout
 362
 363 \begin_layout Subsection*
 364 font-state
 365 \end_layout
 366
 367 \begin_layout Description
 368 Action Returns the info about the current font.
 369 \end_layout
 370
 371 \begin_layout Description
 372 Syntax font-state
 373 \end_layout
 374
 375 \begin_layout Subsection*
 376 font-strikeout
 377 \end_layout
 378
 379 \begin_layout Description
 380 Action Toggles strikeout (strike-through) in the font (selection-wise).
 381 \end_layout
 382
 383 \begin_layout Description
 384 Syntax font-strikeout
 385 \end_layout
 386
 387 \begin_layout Description
 388 Origin sanda, 3 May 2009
 389 \end_layout
 390
 391 \begin_layout Subsection*
 392 font-typewriter
 393 \end_layout
 394
 395 \begin_layout Description
 396 Action Toggles the typewriter family font (selection-wise).
 397 \end_layout
 398
 399 \begin_layout Description
 400 Syntax font-typewriter
 401 \end_layout
 402
 403 \begin_layout Subsection*
 404 font-underline
 405 \end_layout
 406
 407 \begin_layout Description
 408 Action Toggles underline in the font (selection-wise).
 409 \end_layout
 410
 411 \begin_layout Description
 412 Syntax font-underline
 413 \end_layout
 414
 415 \begin_layout Subsection*
 416 font-underunderline
 417 \end_layout
 418
 419 \begin_layout Description
 420 Action Toggles double underline in the font (selection-wise).
 421 \end_layout
 422
 423 \begin_layout Description
 424 Syntax font-underunderline
 425 \end_layout
 426
 427 \begin_layout Description
 428 Origin sanda, 5 May 2009
 429 \end_layout
 430
 431 \begin_layout Subsection*
 432 font-underwave
 433 \end_layout
 434
 435 \begin_layout Description
 436 Action Toggles wavy underline in the font (selection-wise).
 437 \end_layout
 438
 439 \begin_layout Description
 440 Syntax font-underwave
 441 \end_layout
 442
 443 \begin_layout Description
 444 Origin sanda, 5 May 2009
 445 \end_layout
 446
 447 \begin_layout Subsection*
 448 layout
 449 \end_layout
 450
 451 \begin_layout Description
 452 Action Sets the layout (that is, environment) for the current paragraph.
 453 \end_layout
 454
 455 \begin_layout Description
 456 Syntax layout <LAYOUT> [ignoreautonests]
 457 \end_layout
 458
 459 \begin_layout Description
 460 Params <LAYOUT>: the layout to use
 461 \begin_inset Newline newline
 462 \end_inset
 463
 464 ignoreautonests: If specified, nesting advices will be ignored.
 465 \end_layout
 466
 467 \begin_layout Subsection*
 468 layout-module-add
 469 \end_layout
 470
 471 \begin_layout Description
 472 Action Adds a module.
 473 \end_layout
 474
 475 \begin_layout Description
 476 Notion Adds a module to the list of included modules for the current buffer.
 477 \end_layout
 478
 479 \begin_layout Description
 480 Syntax layout-module-add <MODULE>
 481 \end_layout
 482
 483 \begin_layout Description
 484 Params <MODULE>: the module to be added
 485 \end_layout
 486
 487 \begin_layout Description
 488 Origin rgh, 25 August 2007
 489 \end_layout
 490
 491 \begin_layout Subsection*
 492 layout-modules-clear
 493 \end_layout
 494
 495 \begin_layout Description
 496 Action Clears the module list.
 497 \end_layout
 498
 499 \begin_layout Description
 500 Notion Clears the list of included modules for the current buffer.
 501 \end_layout
 502
 503 \begin_layout Description
 504 Syntax layout-modules-clear
 505 \end_layout
 506
 507 \begin_layout Description
 508 Origin rgh, 25 August 2007
 509 \end_layout
 510
 511 \begin_layout Subsection*
 512 layout-paragraph
 513 \end_layout
 514
 515 \begin_layout Description
 516 Action Launches the paragraph settings dialog.
 517 \end_layout
 518
 519 \begin_layout Description
 520 Syntax layout-paragraph
 521 \end_layout
 522
 523 \begin_layout Subsection*
 524 layout-reload
 525 \end_layout
 526
 527 \begin_layout Description
 528 Action Reloads layout information.
 529 \end_layout
 530
 531 \begin_layout Description
 532 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.
 533 \end_layout
 534
 535 \begin_layout Description
 536 Syntax layout-reload
 537 \end_layout
 538
 539 \begin_layout Description
 540 Origin rgh, 3 September 2007
 541 \end_layout
 542
 543 \begin_layout Subsection*
 544 layout-tabular
 545 \end_layout
 546
 547 \begin_layout Description
 548 Action Launches the tabular settings dialog.
 549 \end_layout
 550
 551 \begin_layout Description
 552 Syntax layout-tabular
 553 \end_layout
 554
 555 \begin_layout Description
 556 Origin Jug, 31 Jul 2000
 557 \end_layout
 558
 559 \begin_layout Subsection*
 560 layout-toggle
 561 \end_layout
 562
 563 \begin_layout Description
 564 Action Toggles the layout (that is, environment) for the current paragraph.
 565 \end_layout
 566
 567 \begin_layout Description
 568 Notion Contrary to `layout', this function resets the current (or selection) layout to the standard layout it already has the correct layout. Useful for toolbar icons.
 569 \end_layout
 570
 571 \begin_layout Description
 572 Syntax layout-toggle <LAYOUT> [ignoreautonests]
 573 \end_layout
 574
 575 \begin_layout Description
 576 Params <LAYOUT>: the layout to toggle
 577 \begin_inset Newline newline
 578 \end_inset
 579
 580 ignoreautonests: If specified, nesting advices will be ignored.
 581 \end_layout
 582
 583 \begin_layout Description
 584 Origin lasgouttes, 14 May 2018
 585 \end_layout
 586
 587 \begin_layout Subsection*
 588 screen-font-update
 589 \end_layout
 590
 591 \begin_layout Description
 592 Action Update fonts and its metrics.
 593 \end_layout
 594
 595 \begin_layout Description
 596 Notion Automatically called after zoom, dpi, font names, or norm change.
 597 \end_layout
 598
 599 \begin_layout Description
 600 Syntax screen-font-update
 601 \end_layout
 602
 603 \begin_layout Description
 604 Origin ARRae, 13 Aug 2000
 605 \end_layout
 606
 607 \begin_layout Subsection*
 608 textclass-apply
 609 \end_layout
 610
 611 \begin_layout Description
 612 Action Sets the text class for the current buffer.
 613 \end_layout
 614
 615 \begin_layout Description
 616 Syntax textclass-apply <TEXTCLASS>
 617 \end_layout
 618
 619 \begin_layout Description
 620 Params <TEXTCLASS>: the textclass to set. Note that this must be the filename, minus the ".layout" extension.
 621 \end_layout
 622
 623 \begin_layout Subsection*
 624 textclass-load
 625 \end_layout
 626
 627 \begin_layout Description
 628 Action Loads information for a textclass from disk.
 629 \end_layout
 630
 631 \begin_layout Description
 632 Syntax textclass-load <TEXTCLASS>
 633 \end_layout
 634
 635 \begin_layout Description
 636 Params <TEXTCLASS>: the textclass to load. Note that this must be the filename, minus the ".layout" extension.
 637 \end_layout
 638
 639 \begin_layout Subsection*
 640 textstyle-apply
 641 \end_layout
 642
 643 \begin_layout Description
 644 Action Apply last used text properties.
 645 \end_layout
 646
 647 \begin_layout Description
 648 Notion These properties are stored via LFUN_TEXTSTYLE_UPDATE, which is automatically triggered when using Text Style dialog.
 649 \end_layout
 650
 651 \begin_layout Description
 652 Syntax textstyle-apply [<NUM>]textstyle-apply
 653 \end_layout
 654
 655 \begin_layout Description
 656 Params <NUM>: number of the selection in the internal freefonts stack to be applied.
 657 \end_layout
 658
 659 \begin_layout Description
 660 Origin leeming, 12 Mar 2003
 661 \end_layout
 662
 663 \begin_layout Subsection*
 664 textstyle-update
 665 \end_layout
 666
 667 \begin_layout Description
 668 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APPLY.
 669 \end_layout
 670
 671 \begin_layout Description
 672 Syntax textstyle-update <FONT_INFO>
 673 \end_layout
 674
 675 \begin_layout Description
 676 Params <FONT_INFO>: specifies font attributes, e.g. family, series, shape, size, emph, noun, underbar, number, color, language, toggleall.
 677 \begin_inset Newline newline
 678 \end_inset
 679
 680 Use lyx -dbg action for exact syntax of text-style dialog parameters.
 681 \end_layout
 682
 683 \begin_layout Description
 684 Origin leeming, 12 Mar 2003
 685 \end_layout
 686
 687 \begin_layout Section
 688 Editing Functions (Cursor and Mouse Movement, Copy/Paste etc.)
 689 \end_layout
 690
 691 \begin_layout Subsection*
 692 accent-acute
 693 \end_layout
 694
 695 \begin_layout Description
 696 Action Adds an acute accent to the next character typed.
 697 \end_layout
 698
 699 \begin_layout Description
 700 Syntax accent-acute
 701 \end_layout
 702
 703 \begin_layout Subsection*
 704 accent-breve
 705 \end_layout
 706
 707 \begin_layout Description
 708 Action Adds a breve accent to the next character typed.
 709 \end_layout
 710
 711 \begin_layout Description
 712 Syntax accent-breve
 713 \end_layout
 714
 715 \begin_layout Subsection*
 716 accent-caron
 717 \end_layout
 718
 719 \begin_layout Description
 720 Action Adds a caron to the next character typed.
 721 \end_layout
 722
 723 \begin_layout Description
 724 Syntax accent-caron
 725 \end_layout
 726
 727 \begin_layout Subsection*
 728 accent-cedilla
 729 \end_layout
 730
 731 \begin_layout Description
 732 Action Adds a cedilla to the next character typed.
 733 \end_layout
 734
 735 \begin_layout Description
 736 Syntax accent-cedilla
 737 \end_layout
 738
 739 \begin_layout Subsection*
 740 accent-circle
 741 \end_layout
 742
 743 \begin_layout Description
 744 Action Adds a circle accent to the next character typed.
 745 \end_layout
 746
 747 \begin_layout Description
 748 Syntax accent-circle
 749 \end_layout
 750
 751 \begin_layout Subsection*
 752 accent-circumflex
 753 \end_layout
 754
 755 \begin_layout Description
 756 Action Adds a circumflex to the next character typed.
 757 \end_layout
 758
 759 \begin_layout Description
 760 Syntax accent-circumflex
 761 \end_layout
 762
 763 \begin_layout Subsection*
 764 accent-dot
 765 \end_layout
 766
 767 \begin_layout Description
 768 Action Adds a dot accent to the next character typed.
 769 \end_layout
 770
 771 \begin_layout Description
 772 Syntax accent-dot
 773 \end_layout
 774
 775 \begin_layout Subsection*
 776 accent-grave
 777 \end_layout
 778
 779 \begin_layout Description
 780 Action Adds a grave accent to the next character typed.
 781 \end_layout
 782
 783 \begin_layout Description
 784 Syntax accent-grave
 785 \end_layout
 786
 787 \begin_layout Subsection*
 788 accent-hungarian-umlaut
 789 \end_layout
 790
 791 \begin_layout Description
 792 Action Adds a Hungarian umlaut to the next character typed.
 793 \end_layout
 794
 795 \begin_layout Description
 796 Syntax accent-grave
 797 \end_layout
 798
 799 \begin_layout Subsection*
 800 accent-macron
 801 \end_layout
 802
 803 \begin_layout Description
 804 Action Adds a macron to the next character typed.
 805 \end_layout
 806
 807 \begin_layout Description
 808 Syntax accent-macron
 809 \end_layout
 810
 811 \begin_layout Subsection*
 812 accent-ogonek
 813 \end_layout
 814
 815 \begin_layout Description
 816 Action Adds an ogonek accent to the next character typed.
 817 \end_layout
 818
 819 \begin_layout Description
 820 Syntax accent-ogonek
 821 \end_layout
 822
 823 \begin_layout Subsection*
 824 accent-perispomeni
 825 \end_layout
 826
 827 \begin_layout Description
 828 Action Adds a perispomeni (Greek circumflex) over the next character typed.
 829 \end_layout
 830
 831 \begin_layout Description
 832 Syntax accent-perispomeni
 833 \end_layout
 834
 835 \begin_layout Subsection*
 836 accent-tie
 837 \end_layout
 838
 839 \begin_layout Description
 840 Action Adds a tie over the next two character typed.
 841 \end_layout
 842
 843 \begin_layout Description
 844 Notion The following char will finish the tie.
 845 \end_layout
 846
 847 \begin_layout Description
 848 Syntax accent-tie
 849 \end_layout
 850
 851 \begin_layout Subsection*
 852 accent-tilde
 853 \end_layout
 854
 855 \begin_layout Description
 856 Action Adds a tilde over the next character typed.
 857 \end_layout
 858
 859 \begin_layout Description
 860 Syntax accent-tilde
 861 \end_layout
 862
 863 \begin_layout Subsection*
 864 accent-umlaut
 865 \end_layout
 866
 867 \begin_layout Description
 868 Action Adds an umlaut over the next character typed.
 869 \end_layout
 870
 871 \begin_layout Description
 872 Syntax accent-umlaut
 873 \end_layout
 874
 875 \begin_layout Subsection*
 876 accent-underbar
 877 \end_layout
 878
 879 \begin_layout Description
 880 Action Adds a bar under the next character typed.
 881 \end_layout
 882
 883 \begin_layout Description
 884 Syntax accent-underbar
 885 \end_layout
 886
 887 \begin_layout Subsection*
 888 accent-underdot
 889 \end_layout
 890
 891 \begin_layout Description
 892 Action Adds a dot under the next character typed.
 893 \end_layout
 894
 895 \begin_layout Description
 896 Syntax accent-underdot
 897 \end_layout
 898
 899 \begin_layout Subsection*
 900 all-changes-accept
 901 \end_layout
 902
 903 \begin_layout Description
 904 Action Accepts all tracked changes in the document.
 905 \end_layout
 906
 907 \begin_layout Description
 908 Syntax all-changes-accept
 909 \end_layout
 910
 911 \begin_layout Description
 912 Origin Levon, 16 Oct 2002
 913 \end_layout
 914
 915 \begin_layout Subsection*
 916 all-changes-reject
 917 \end_layout
 918
 919 \begin_layout Description
 920 Action Rejects all tracked changes in the document.
 921 \end_layout
 922
 923 \begin_layout Description
 924 Notion Reject does not work recursively; the user may have to repeat the operation.
 925 \end_layout
 926
 927 \begin_layout Description
 928 Syntax all-changes-reject
 929 \end_layout
 930
 931 \begin_layout Description
 932 Origin Levon, 16 Oct 2002
 933 \end_layout
 934
 935 \begin_layout Subsection*
 936 appendix
 937 \end_layout
 938
 939 \begin_layout Description
 940 Action Start (or remove) Appendix on the given cursor position.
 941 \end_layout
 942
 943 \begin_layout Description
 944 Syntax appendix
 945 \end_layout
 946
 947 \begin_layout Description
 948 Origin ettrich, 5 May 1998
 949 \end_layout
 950
 951 \begin_layout Subsection*
 952 argument-insert
 953 \end_layout
 954
 955 \begin_layout Description
 956 Action Inserts an argument (short title) inset.
 957 \end_layout
 958
 959 \begin_layout Description
 960 Syntax argument-insert <argument nr>
 961 \end_layout
 962
 963 \begin_layout Description
 964 Params <argument nr>: see layout declarations
 965 \end_layout
 966
 967 \begin_layout Description
 968 Origin vermeer, 12 Aug 2002
 969 \end_layout
 970
 971 \begin_layout Subsection*
 972 bibtex-database-add
 973 \end_layout
 974
 975 \begin_layout Description
 976 Action Adds database, which will be used for bibtex citations.
 977 \end_layout
 978
 979 \begin_layout Description
 980 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
 981 \end_layout
 982
 983 \begin_layout Description
 984 Syntax bibtex-database-add <DATABASE-NAME>
 985 \end_layout
 986
 987 \begin_layout Description
 988 Origin Ale, 30 May 1997
 989 \end_layout
 990
 991 \begin_layout Subsection*
 992 bibtex-database-del
 993 \end_layout
 994
 995 \begin_layout Description
 996 Action Adds database, which will be used for bibtex citations.
 997 \end_layout
 998
 999 \begin_layout Description
1000 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
1001 \end_layout
1002
1003 \begin_layout Description
1004 Syntax bibtex-database-del <DATABASE-NAME>
1005 \end_layout
1006
1007 \begin_layout Description
1008 Origin Ale, 30 May 1997
1009 \end_layout
1010
1011 \begin_layout Subsection*
1012 bookmark-clear
1013 \end_layout
1014
1015 \begin_layout Description
1016 Action Clears the list of saved bookmarks.
1017 \end_layout
1018
1019 \begin_layout Description
1020 Syntax bookmark-clear
1021 \end_layout
1022
1023 \begin_layout Description
1024 Origin bpeng, 31 October 2006
1025 \end_layout
1026
1027 \begin_layout Subsection*
1028 bookmark-goto
1029 \end_layout
1030
1031 \begin_layout Description
1032 Action Moves the cursor to the numbered bookmark, opening the file if necessary. Note that bookmarks are saved per-session, not per file.
1033 \end_layout
1034
1035 \begin_layout Description
1036 Notion Bookmark 0 has a special purpose. It is automatically set
1037 \begin_inset Newline newline
1038 \end_inset
1039
1040 1. to the paragraph you are currently editing
1041 \begin_inset Newline newline
1042 \end_inset
1043
1044 2. to the paragraph from where you are jumping to the last-edited position (jump-back feature)
1045 \begin_inset Newline newline
1046 \end_inset
1047
1048 3. when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
1049 \end_layout
1050
1051 \begin_layout Description
1052 Syntax bookmark-goto <NUMBER>
1053 \end_layout
1054
1055 \begin_layout Description
1056 Params <NUMBER>: the number of the bookmark to restore.
1057 \end_layout
1058
1059 \begin_layout Description
1060 Origin Dekel, 27 January 2001
1061 \end_layout
1062
1063 \begin_layout Subsection*
1064 bookmark-save
1065 \end_layout
1066
1067 \begin_layout Description
1068 Action Save a bookmark.
1069 \end_layout
1070
1071 \begin_layout Description
1072 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.
1073 \end_layout
1074
1075 \begin_layout Description
1076 Syntax bookmark-save <NUMBER>
1077 \end_layout
1078
1079 \begin_layout Description
1080 Params <NUMBER>: the number of the bookmark to save.
1081 \end_layout
1082
1083 \begin_layout Description
1084 Origin Dekel, 27 January 2001
1085 \end_layout
1086
1087 \begin_layout Subsection*
1088 box-insert
1089 \end_layout
1090
1091 \begin_layout Description
1092 Action Inserts Box inset.
1093 \end_layout
1094
1095 \begin_layout Description
1096 Syntax box-insert [<TYPE>]
1097 \end_layout
1098
1099 \begin_layout Description
1100 Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
1101 \begin_inset Newline newline
1102 \end_inset
1103
1104 Framed is the default one.
1105 \end_layout
1106
1107 \begin_layout Description
1108 Origin vermeer, 7 Oct 2003
1109 \end_layout
1110
1111 \begin_layout Subsection*
1112 branch-insert
1113 \end_layout
1114
1115 \begin_layout Description
1116 Action Inserts branch inset.
1117 \end_layout
1118
1119 \begin_layout Description
1120 Syntax branch-insert <BRANCH-NAME>
1121 \end_layout
1122
1123 \begin_layout Description
1124 Origin vermeer, 17 Aug 2003
1125 \end_layout
1126
1127 \begin_layout Subsection*
1128 buffer-anonymize
1129 \end_layout
1130
1131 \begin_layout Description
1132 Action For debug purposes only. Convert all [a-zA-Z0-1] characters to single character. Useful when submitting docs to list or bugzilla.
1133 \end_layout
1134
1135 \begin_layout Description
1136 Syntax buffer-anonymize
1137 \end_layout
1138
1139 \begin_layout Description
1140 Origin sanda, Feb 1 2018
1141 \end_layout
1142
1143 \begin_layout Subsection*
1144 buffer-begin
1145 \end_layout
1146
1147 \begin_layout Description
1148 Action Move the cursor to the beginning of the document.
1149 \end_layout
1150
1151 \begin_layout Description
1152 Syntax buffer-begin
1153 \end_layout
1154
1155 \begin_layout Subsection*
1156 buffer-begin-select
1157 \end_layout
1158
1159 \begin_layout Description
1160 Action Move the cursor to the beginning of the document adding the traversed text to the selection.
1161 \end_layout
1162
1163 \begin_layout Description
1164 Syntax buffer-begin-select
1165 \end_layout
1166
1167 \begin_layout Subsection*
1168 buffer-end
1169 \end_layout
1170
1171 \begin_layout Description
1172 Action Move the cursor to the end of the document.
1173 \end_layout
1174
1175 \begin_layout Description
1176 Syntax buffer-end
1177 \end_layout
1178
1179 \begin_layout Subsection*
1180 buffer-end-select
1181 \end_layout
1182
1183 \begin_layout Description
1184 Action Move the cursor to the end of the document adding the traversed text to the selection.
1185 \end_layout
1186
1187 \begin_layout Description
1188 Syntax buffer-end-select
1189 \end_layout
1190
1191 \begin_layout Subsection*
1192 caption-insert
1193 \end_layout
1194
1195 \begin_layout Description
1196 Action Inserts a caption inset.
1197 \end_layout
1198
1199 \begin_layout Description
1200 Syntax caption-insert
1201 \end_layout
1202
1203 \begin_layout Description
1204 Origin Lgb, 18 Jul 2000
1205 \end_layout
1206
1207 \begin_layout Subsection*
1208 cell-backward
1209 \end_layout
1210
1211 \begin_layout Description
1212 Action Moves the cursor to the previous cell inside the table.
1213 \end_layout
1214
1215 \begin_layout Description
1216 Syntax cell-backward
1217 \end_layout
1218
1219 \begin_layout Description
1220 Origin Jug, 22 May 2000
1221 \end_layout
1222
1223 \begin_layout Subsection*
1224 cell-forward
1225 \end_layout
1226
1227 \begin_layout Description
1228 Action Moves the cursor to the next cell inside the table.
1229 \end_layout
1230
1231 \begin_layout Description
1232 Syntax cell-forward
1233 \end_layout
1234
1235 \begin_layout Subsection*
1236 cell-split
1237 \end_layout
1238
1239 \begin_layout Description
1240 Action Splits cell and shifts right part to the next cell (inside the math grid).
1241 \end_layout
1242
1243 \begin_layout Description
1244 Syntax cell-split
1245 \end_layout
1246
1247 \begin_layout Description
1248 Origin Ale, 15 May 1997
1249 \end_layout
1250
1251 \begin_layout Subsection*
1252 change-accept
1253 \end_layout
1254
1255 \begin_layout Description
1256 Action Accepts tracked change inside the selection.
1257 \end_layout
1258
1259 \begin_layout Description
1260 Syntax change-accept
1261 \end_layout
1262
1263 \begin_layout Description
1264 Origin Levon, 16 Oct 2002
1265 \end_layout
1266
1267 \begin_layout Subsection*
1268 change-next
1269 \end_layout
1270
1271 \begin_layout Description
1272 Action Moves the cursor to the position of the next change of the change tracking records.
1273 \end_layout
1274
1275 \begin_layout Description
1276 Syntax change-next
1277 \end_layout
1278
1279 \begin_layout Description
1280 Origin schmitt, 4 Oct 2006
1281 \end_layout
1282
1283 \begin_layout Subsection*
1284 change-previous
1285 \end_layout
1286
1287 \begin_layout Description
1288 Action Moves the cursor to the position of the previous change of the change tracking records.
1289 \end_layout
1290
1291 \begin_layout Description
1292 Syntax change-previous
1293 \end_layout
1294
1295 \begin_layout Description
1296 Origin vfr, 4 Apr 2009
1297 \end_layout
1298
1299 \begin_layout Subsection*
1300 change-reject
1301 \end_layout
1302
1303 \begin_layout Description
1304 Action Rejects tracked change inside the selection.
1305 \end_layout
1306
1307 \begin_layout Description
1308 Syntax change-reject
1309 \end_layout
1310
1311 \begin_layout Description
1312 Origin Levon, 16 Oct 2002
1313 \end_layout
1314
1315 \begin_layout Subsection*
1316 changes-merge
1317 \end_layout
1318
1319 \begin_layout Description
1320 Action Open change tracking dialog for merging and moves the cursor to the position of the next change.
1321 \end_layout
1322
1323 \begin_layout Description
1324 Syntax changes-merge
1325 \end_layout
1326
1327 \begin_layout Description
1328 Origin Levon, 16 Oct 2002
1329 \end_layout
1330
1331 \begin_layout Subsection*
1332 changes-output
1333 \end_layout
1334
1335 \begin_layout Description
1336 Action Toggles showing of change tracking in typeset output.
1337 \end_layout
1338
1339 \begin_layout Description
1340 Syntax changes-output
1341 \end_layout
1342
1343 \begin_layout Description
1344 Origin spitz, 21 Jan 2005
1345 \end_layout
1346
1347 \begin_layout Subsection*
1348 changes-track
1349 \end_layout
1350
1351 \begin_layout Description
1352 Action Toggles change tracking to on/off.
1353 \end_layout
1354
1355 \begin_layout Description
1356 Syntax changes-track
1357 \end_layout
1358
1359 \begin_layout Description
1360 Origin levon, 1 Oct 2002
1361 \end_layout
1362
1363 \begin_layout Subsection*
1364 char-backward
1365 \end_layout
1366
1367 \begin_layout Description
1368 Action Moves the cursor one position logically backwards.
1369 \end_layout
1370
1371 \begin_layout Description
1372 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.
1373 \end_layout
1374
1375 \begin_layout Description
1376 Syntax char-backward
1377 \end_layout
1378
1379 \begin_layout Subsection*
1380 char-backward-select
1381 \end_layout
1382
1383 \begin_layout Description
1384 Action Moves the cursor one position logically backwards, adding traversed position to the selection.
1385 \end_layout
1386
1387 \begin_layout Description
1388 Notion See also LFUN_CHAR_BACKWARD.
1389 \end_layout
1390
1391 \begin_layout Description
1392 Syntax char-backward-select
1393 \end_layout
1394
1395 \begin_layout Subsection*
1396 char-delete-backward
1397 \end_layout
1398
1399 \begin_layout Description
1400 Action Deletes one character in the backward direction (usually the "BackSpace" key).
1401 \end_layout
1402
1403 \begin_layout Description
1404 Syntax char-delete-backward [force]
1405 \end_layout
1406
1407 \begin_layout Description
1408 Params force: Delete big insets, do not only select them.
1409 \end_layout
1410
1411 \begin_layout Subsection*
1412 char-delete-forward
1413 \end_layout
1414
1415 \begin_layout Description
1416 Action Deletes one character in the backward direction (usually the "Delete" key).
1417 \end_layout
1418
1419 \begin_layout Description
1420 Syntax char-delete-forward [force]
1421 \end_layout
1422
1423 \begin_layout Description
1424 Params force: Delete big insets, do not only select them.
1425 \end_layout
1426
1427 \begin_layout Subsection*
1428 char-forward
1429 \end_layout
1430
1431 \begin_layout Description
1432 Action Moves the cursor one position logically forward.
1433 \end_layout
1434
1435 \begin_layout Description
1436 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.
1437 \end_layout
1438
1439 \begin_layout Description
1440 Syntax char-forward
1441 \end_layout
1442
1443 \begin_layout Subsection*
1444 char-forward-select
1445 \end_layout
1446
1447 \begin_layout Description
1448 Action Moves the cursor one position logically forward, adding traversed position to the selection.
1449 \end_layout
1450
1451 \begin_layout Description
1452 Notion See also LFUN_CHAR_FORWARD.
1453 \end_layout
1454
1455 \begin_layout Description
1456 Syntax char-forward-select
1457 \end_layout
1458
1459 \begin_layout Subsection*
1460 char-left
1461 \end_layout
1462
1463 \begin_layout Description
1464 Action Moves the cursor one position "to the left".
1465 \end_layout
1466
1467 \begin_layout Description
1468 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.
1469 \end_layout
1470
1471 \begin_layout Description
1472 Syntax char-left
1473 \end_layout
1474
1475 \begin_layout Subsection*
1476 char-left-select
1477 \end_layout
1478
1479 \begin_layout Description
1480 Action Moves the cursor one position "to the left", adding traversed position to the selection.
1481 \end_layout
1482
1483 \begin_layout Description
1484 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1485 \end_layout
1486
1487 \begin_layout Description
1488 Syntax char-left-select
1489 \end_layout
1490
1491 \begin_layout Subsection*
1492 char-right
1493 \end_layout
1494
1495 \begin_layout Description
1496 Action Moves the cursor one position "to the right".
1497 \end_layout
1498
1499 \begin_layout Description
1500 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.
1501 \end_layout
1502
1503 \begin_layout Description
1504 Syntax char-right
1505 \end_layout
1506
1507 \begin_layout Subsection*
1508 char-right-select
1509 \end_layout
1510
1511 \begin_layout Description
1512 Action Moves the cursor one position "to the right", adding traversed position to the selection.
1513 \end_layout
1514
1515 \begin_layout Description
1516 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1517 \end_layout
1518
1519 \begin_layout Description
1520 Syntax char-right-select
1521 \end_layout
1522
1523 \begin_layout Subsection*
1524 chars-transpose
1525 \end_layout
1526
1527 \begin_layout Description
1528 Action Transposes the character at the cursor with the one before it.
1529 \end_layout
1530
1531 \begin_layout Description
1532 Syntax chars-transpose
1533 \end_layout
1534
1535 \begin_layout Description
1536 Origin Lgb, 25 Apr 2001
1537 \end_layout
1538
1539 \begin_layout Subsection*
1540 citation-insert
1541 \end_layout
1542
1543 \begin_layout Description
1544 Action Inserts citation from loaded citation database.
1545 \end_layout
1546
1547 \begin_layout Description
1548 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
1549 \end_layout
1550
1551 \begin_layout Description
1552 Params <KEY>: Citation (shortcut listed in available citations).
1553 \begin_inset Newline newline
1554 \end_inset
1555
1556 <TEXT_BEFORE>: text which should appear before citation.
1557 \end_layout
1558
1559 \begin_layout Description
1560 Origin AAS, 97-02-23
1561 \end_layout
1562
1563 \begin_layout Subsection*
1564 citation-open
1565 \end_layout
1566
1567 \begin_layout Description
1568 Action Opens the corresponding pdf/url for a given citation inset.
1569 \end_layout
1570
1571 \begin_layout Description
1572 Syntax citation-open [EXTERNAL] TARGET
1573 \end_layout
1574
1575 \begin_layout Description
1576 Params <TARGET>: URL (https:,file:) of the document.
1577 \begin_inset Newline newline
1578 \end_inset
1579
1580 <EXTERNAL>: Use external executable script for finding target
1581 \begin_inset Newline newline
1582 \end_inset
1583
1584                and launching viewer. In this case TARGET consists of author and year
1585 \begin_inset Newline newline
1586 \end_inset
1587
1588                and will be passed as an input argument to the script.
1589 \end_layout
1590
1591 \begin_layout Description
1592 Origin Sanda, 16 Aug 2020
1593 \end_layout
1594
1595 \begin_layout Subsection*
1596 clipboard-paste
1597 \end_layout
1598
1599 \begin_layout Description
1600 Action Pastes text from the active clipboard (retains formatting if the clipboard contains formatted text). Pastes plain text if plain text is on the clipboard, but tries to interpret it in special ways for certain insets, e.g. converting csv data to rows and columns if the paste happens in a tabular inset.
1601 \end_layout
1602
1603 \begin_layout Description
1604 Notion Historically, LFUN_CLIPBOARD_PASTE was introduced as a counterpart of LFUN_PRIMARY_SELECTION_PASTE: It behaved exactly the same, but the source is the clipboard, not the selection.
1605 \end_layout
1606
1607 \begin_layout Description
1608 Syntax clipboard-paste [<ARG>]
1609 \end_layout
1610
1611 \begin_layout Description
1612 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1613 \end_layout
1614
1615 \begin_layout Description
1616 Origin Georg, 10 Jul 2006
1617 \end_layout
1618
1619 \begin_layout Subsection*
1620 clipboard-paste-simple
1621 \end_layout
1622
1623 \begin_layout Description
1624 Action Pastes plain text from the active clipboard even if formatted LyX content is in the clipboard. Pastes plain text if plain text is on the clipboard, without trying to interpret it in special ways for certain insets, e.g. converting csv data to rows and columns if the paste happens in a tabular inset.
1625 \end_layout
1626
1627 \begin_layout Description
1628 Syntax clipboard-paste-simple [<ARG>]
1629 \end_layout
1630
1631 \begin_layout Description
1632 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1633 \end_layout
1634
1635 \begin_layout Subsection*
1636 command-execute
1637 \end_layout
1638
1639 \begin_layout Description
1640 Action Switches the focus to the minibuffer so that the user can type in there. If necessary, it opens the minibuffer toolbar.
1641 \end_layout
1642
1643 \begin_layout Description
1644 Notion Usually bound to M-x shortcut.
1645 \end_layout
1646
1647 \begin_layout Description
1648 Syntax command-execute
1649 \end_layout
1650
1651 \begin_layout Subsection*
1652 complete
1653 \end_layout
1654
1655 \begin_layout Description
1656 Action Try to complete the word or command at the cursor position.
1657 \end_layout
1658
1659 \begin_layout Description
1660 Syntax complete
1661 \end_layout
1662
1663 \begin_layout Description
1664 Origin sts, Feb 19 2008
1665 \end_layout
1666
1667 \begin_layout Subsection*
1668 completion-accept
1669 \end_layout
1670
1671 \begin_layout Description
1672 Action Accept suggested completion.
1673 \end_layout
1674
1675 \begin_layout Description
1676 Syntax completion-accept
1677 \end_layout
1678
1679 \begin_layout Description
1680 Origin sanda, Sep 08 2008
1681 \end_layout
1682
1683 \begin_layout Subsection*
1684 completion-cancel
1685 \end_layout
1686
1687 \begin_layout Description
1688 Action Try to cancel completion, either the popup or the inline completion.
1689 \end_layout
1690
1691 \begin_layout Description
1692 Syntax completion-cancel
1693 \end_layout
1694
1695 \begin_layout Description
1696 Origin sts, Sep 07 2008
1697 \end_layout
1698
1699 \begin_layout Subsection*
1700 completion-inline
1701 \end_layout
1702
1703 \begin_layout Description
1704 Action Show the inline completion at the cursor position.
1705 \end_layout
1706
1707 \begin_layout Description
1708 Syntax completion-inline
1709 \end_layout
1710
1711 \begin_layout Description
1712 Origin sts, Feb 19 2008
1713 \end_layout
1714
1715 \begin_layout Subsection*
1716 completion-popup
1717 \end_layout
1718
1719 \begin_layout Description
1720 Action Show the completion popup at the cursor position.
1721 \end_layout
1722
1723 \begin_layout Description
1724 Syntax completion-popup
1725 \end_layout
1726
1727 \begin_layout Description
1728 Origin sts, Feb 19 2008
1729 \end_layout
1730
1731 \begin_layout Subsection*
1732 copy
1733 \end_layout
1734
1735 \begin_layout Description
1736 Action Copies the current selection to the clipboard.
1737 \end_layout
1738
1739 \begin_layout Description
1740 Syntax copy
1741 \end_layout
1742
1743 \begin_layout Subsection*
1744 cut
1745 \end_layout
1746
1747 \begin_layout Description
1748 Action Cuts to the clipboard.
1749 \end_layout
1750
1751 \begin_layout Description
1752 Syntax cut
1753 \end_layout
1754
1755 \begin_layout Subsection*
1756 depth-decrement
1757 \end_layout
1758
1759 \begin_layout Description
1760 Action Decrease the nesting depth of the (selected) paragraph(s) inside lists.
1761 \end_layout
1762
1763 \begin_layout Description
1764 Syntax depth-decrement
1765 \end_layout
1766
1767 \begin_layout Subsection*
1768 depth-increment
1769 \end_layout
1770
1771 \begin_layout Description
1772 Action Increase the nesting depth of the (selected) paragraph(s) inside lists.
1773 \end_layout
1774
1775 \begin_layout Description
1776 Syntax depth-increment
1777 \end_layout
1778
1779 \begin_layout Subsection*
1780 dialog-disconnect-inset
1781 \end_layout
1782
1783 \begin_layout Description
1784 Action Closes opened connection to opened inset.
1785 \end_layout
1786
1787 \begin_layout Description
1788 Notion Connection is used for apply functions.
1789 \end_layout
1790
1791 \begin_layout Description
1792 Syntax dialog-disconnect-inset <INSET-NAME>
1793 \end_layout
1794
1795 \begin_layout Description
1796 Origin leeming, 25 Feb 2003
1797 \end_layout
1798
1799 \begin_layout Subsection*
1800 dialog-hide
1801 \end_layout
1802
1803 \begin_layout Description
1804 Action Hides showed dialog. Counterpart to LFUN_DIALOG_SHOW .
1805 \end_layout
1806
1807 \begin_layout Description
1808 Syntax dialog-hide <NAME>
1809 \end_layout
1810
1811 \begin_layout Description
1812 Params See LFUN_DIALOG_SHOW .
1813 \end_layout
1814
1815 \begin_layout Description
1816 Origin leeming, 25 Feb 2003
1817 \end_layout
1818
1819 \begin_layout Subsection*
1820 dialog-show
1821 \end_layout
1822
1823 \begin_layout Description
1824 Action Shows hidden dialog or creates new one for a given function/inset settings etc.
1825 \end_layout
1826
1827 \begin_layout Description
1828 Syntax dialog-show <NAME> [<DATA>]
1829 \end_layout
1830
1831 \begin_layout Description
1832 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
1833 \begin_inset Newline newline
1834 \end_inset
1835
1836 compare|counter|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|
1837 \begin_inset Newline newline
1838 \end_inset
1839
1840 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|
1841 \begin_inset Newline newline
1842 \end_inset
1843
1844 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|
1845 \begin_inset Newline newline
1846 \end_inset
1847
1848 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|
1849 \begin_inset Newline newline
1850 \end_inset
1851
1852 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL>
1853 \begin_inset Newline newline
1854 \end_inset
1855
1856 <SPECIAL>: latexlog|vclog
1857 \begin_inset Newline newline
1858 \end_inset
1859
1860 <DATA>: data, usually settings for the given dialog. Use debug mode for the details.
1861 \end_layout
1862
1863 \begin_layout Description
1864 Origin leeming, 17 Jun 2003
1865 \end_layout
1866
1867 \begin_layout Subsection*
1868 dialog-show-new-inset
1869 \end_layout
1870
1871 \begin_layout Description
1872 Action Shows hidden dialog or create new one for a given inset settings etc.
1873 \end_layout
1874
1875 \begin_layout Description
1876 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given inset.
1877 \end_layout
1878
1879 \begin_layout Description
1880 Syntax dialog-show-new-inset <NAME> [<DATA>]
1881 \end_layout
1882
1883 \begin_layout Description
1884 Params See LFUN_DIALOG_SHOW .
1885 \end_layout
1886
1887 \begin_layout Description
1888 Origin leeming, 25 Feb 2003
1889 \end_layout
1890
1891 \begin_layout Subsection*
1892 dialog-toggle
1893 \end_layout
1894
1895 \begin_layout Description
1896 Action Toggles dialog between showed/hidden state.
1897 \end_layout
1898
1899 \begin_layout Description
1900 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
1901 \end_layout
1902
1903 \begin_layout Description
1904 Syntax dialog-toggle <NAME> [<DATA>]
1905 \end_layout
1906
1907 \begin_layout Description
1908 Params See LFUN_DIALOG_SHOW .
1909 \end_layout
1910
1911 \begin_layout Description
1912 Origin spitz, 30 Apr 2007
1913 \end_layout
1914
1915 \begin_layout Subsection*
1916 dialog-update
1917 \end_layout
1918
1919 \begin_layout Description
1920 Action Updates the dialog values from the inset/paragraph/document.
1921 \end_layout
1922
1923 \begin_layout Description
1924 Syntax dialog-update <NAME>
1925 \end_layout
1926
1927 \begin_layout Description
1928 Params <NAME>: paragraph|prefs|<INSET>
1929 \begin_inset Newline newline
1930 \end_inset
1931
1932 <INSET>: inset name
1933 \end_layout
1934
1935 \begin_layout Description
1936 Origin leeming, 25 Feb 2003
1937 \end_layout
1938
1939 \begin_layout Subsection*
1940 down
1941 \end_layout
1942
1943 \begin_layout Description
1944 Action Moves the cursor one line in downward direction.
1945 \end_layout
1946
1947 \begin_layout Description
1948 Syntax down
1949 \end_layout
1950
1951 \begin_layout Subsection*
1952 down-select
1953 \end_layout
1954
1955 \begin_layout Description
1956 Action Moves the cursor one line in downward direction adding the current position to the selection.
1957 \end_layout
1958
1959 \begin_layout Description
1960 Syntax down-select
1961 \end_layout
1962
1963 \begin_layout Subsection*
1964 ert-insert
1965 \end_layout
1966
1967 \begin_layout Description
1968 Action Inserts an ERT inset.
1969 \end_layout
1970
1971 \begin_layout Description
1972 Syntax ert-insert
1973 \end_layout
1974
1975 \begin_layout Description
1976 Origin Jug, 18 Feb 2000
1977 \end_layout
1978
1979 \begin_layout Subsection*
1980 escape
1981 \end_layout
1982
1983 \begin_layout Description
1984 Action Clears the selection. If no text is selected call LFUN_FINISHED_FORWARD. Inside math mode jumps out of the math inset.
1985 \end_layout
1986
1987 \begin_layout Description
1988 Syntax escape
1989 \end_layout
1990
1991 \begin_layout Description
1992 Origin Lgb, 17 May 2001
1993 \end_layout
1994
1995 \begin_layout Subsection*
1996 export-cancel
1997 \end_layout
1998
1999 \begin_layout Description
2000 Action Cancel background export process.
2001 \end_layout
2002
2003 \begin_layout Description
2004 Syntax export-cancel
2005 \end_layout
2006
2007 \begin_layout Description
2008 Origin rgh, 10 December 2017
2009 \end_layout
2010
2011 \begin_layout Subsection*
2012 file-insert
2013 \end_layout
2014
2015 \begin_layout Description
2016 Action Inserts another LyX file.
2017 \end_layout
2018
2019 \begin_layout Description
2020 Syntax file-insert [<FILE>] [ignorelang]
2021 \end_layout
2022
2023 \begin_layout Description
2024 Params <FILE>: Filename to be inserted. ignorelang: If given, the (main) language of the inserted file is ignored (the context language is used).
2025 \end_layout
2026
2027 \begin_layout Subsection*
2028 file-insert-plaintext
2029 \end_layout
2030
2031 \begin_layout Description
2032 Action Inserts plain text file.
2033 \end_layout
2034
2035 \begin_layout Description
2036 Syntax file-insert-plaintext [<FILE>]
2037 \end_layout
2038
2039 \begin_layout Description
2040 Params <FILE>: Filename to be inserted.
2041 \end_layout
2042
2043 \begin_layout Description
2044 Origin CFO-G, 19 Nov 1997
2045 \end_layout
2046
2047 \begin_layout Subsection*
2048 file-insert-plaintext-para
2049 \end_layout
2050
2051 \begin_layout Description
2052 Action Inserts plain text file as paragraph (i.e. join lines).
2053 \end_layout
2054
2055 \begin_layout Description
2056 Syntax file-insert-plaintext-para [<FILE>]
2057 \end_layout
2058
2059 \begin_layout Description
2060 Params <FILE>: Filename to be inserted.
2061 \end_layout
2062
2063 \begin_layout Description
2064 Origin Levon, 14 Feb 2001
2065 \end_layout
2066
2067 \begin_layout Subsection*
2068 flex-insert
2069 \end_layout
2070
2071 \begin_layout Description
2072 Action Inserts CharStyle, Custom inset or XML short element.
2073 \end_layout
2074
2075 \begin_layout Description
2076 Notion Look into the Customization manual for more information about these elements.
2077 \begin_inset Newline newline
2078 \end_inset
2079
2080 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.
2081 \begin_inset Newline newline
2082 \end_inset
2083
2084 For dissolving the element see LFUN_INSET_DISSOLVE.
2085 \end_layout
2086
2087 \begin_layout Description
2088 Syntax flex-insert Name
2089 \end_layout
2090
2091 \begin_layout Description
2092 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.
2093 \end_layout
2094
2095 \begin_layout Description
2096 Sample flex-insert Code
2097 \end_layout
2098
2099 \begin_layout Subsection*
2100 float-insert
2101 \end_layout
2102
2103 \begin_layout Description
2104 Action Inserts a float inset.
2105 \end_layout
2106
2107 \begin_layout Description
2108 Syntax float-insert <TYPE>
2109 \end_layout
2110
2111 \begin_layout Description
2112 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
2113 \end_layout
2114
2115 \begin_layout Description
2116 Origin Lgb, 27 Jun 2000
2117 \end_layout
2118
2119 \begin_layout Subsection*
2120 float-list-insert
2121 \end_layout
2122
2123 \begin_layout Description
2124 Action Inserts the list of floats in the document.
2125 \end_layout
2126
2127 \begin_layout Description
2128 Syntax float-list-insert <TYPE>
2129 \end_layout
2130
2131 \begin_layout Description
2132 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
2133 \end_layout
2134
2135 \begin_layout Description
2136 Origin Lgb, 3 May 2001
2137 \end_layout
2138
2139 \begin_layout Subsection*
2140 float-wide-insert
2141 \end_layout
2142
2143 \begin_layout Description
2144 Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
2145 \end_layout
2146
2147 \begin_layout Description
2148 Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
2149 \end_layout
2150
2151 \begin_layout Description
2152 Syntax float-wide-insert <TYPE>
2153 \end_layout
2154
2155 \begin_layout Description
2156 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
2157 \end_layout
2158
2159 \begin_layout Description
2160 Origin Lgb, 31 Oct 2001
2161 \end_layout
2162
2163 \begin_layout Subsection*
2164 footnote-insert
2165 \end_layout
2166
2167 \begin_layout Description
2168 Action Inserts a footnote inset.
2169 \end_layout
2170
2171 \begin_layout Description
2172 Syntax footnote-insert
2173 \end_layout
2174
2175 \begin_layout Description
2176 Origin Jug, 7 Mar 2000
2177 \end_layout
2178
2179 \begin_layout Subsection*
2180 graphics-reload
2181 \end_layout
2182
2183 \begin_layout Description
2184 Action Reloads the image if necessary.
2185 \end_layout
2186
2187 \begin_layout Description
2188 Syntax graphics-reload
2189 \end_layout
2190
2191 \begin_layout Description
2192 Origin vfr, 10 Aug 2009
2193 \end_layout
2194
2195 \begin_layout Subsection*
2196 graphics-set-group
2197 \end_layout
2198
2199 \begin_layout Description
2200 Action Set the group for the graphics inset on the cursor position.
2201 \end_layout
2202
2203 \begin_layout Description
2204 Syntax graphics-set-group [<GROUP>]
2205 \end_layout
2206
2207 \begin_layout Description
2208 Params <GROUP>: Id for an existing group. In case the Id is an empty string, the graphics inset is removed from the current group.
2209 \end_layout
2210
2211 \begin_layout Description
2212 Origin sanda, 6 May 2008
2213 \end_layout
2214
2215 \begin_layout Subsection*
2216 graphics-unify
2217 \end_layout
2218
2219 \begin_layout Description
2220 Action Set the same group for all graphics insets in the marked block.
2221 \end_layout
2222
2223 \begin_layout Description
2224 Syntax graphics-unify [<GROUP>]
2225 \end_layout
2226
2227 \begin_layout Description
2228 Params <GROUP>: Id for an existing group. In case the Id is an empty string, the group Id from the first graphics inset will be used.
2229 \end_layout
2230
2231 \begin_layout Description
2232 Origin sanda, 7 Feb 2018
2233 \end_layout
2234
2235 \begin_layout Subsection*
2236 href-insert
2237 \end_layout
2238
2239 \begin_layout Description
2240 Action Inserts hyperlinks into the document (clickable in pdf output).
2241 \end_layout
2242
2243 \begin_layout Description
2244 Notion Hyperlink target can be set via selection + hyperlink-insert function.
2245 \end_layout
2246
2247 \begin_layout Description
2248 Syntax href-insert [<TARGET>]
2249 \end_layout
2250
2251 \begin_layout Description
2252 Origin CFO-G, 21 Nov 1997
2253 \end_layout
2254
2255 \begin_layout Subsection*
2256 in-ipa
2257 \end_layout
2258
2259 \begin_layout Description
2260 Action Only active in IPA inset.
2261 \end_layout
2262
2263 \begin_layout Description
2264 Notion Dummy function which is only active in a IPA inset. It's used to toggle the IPA toolbar if the cursor moves into an IPA inset.
2265 \end_layout
2266
2267 \begin_layout Description
2268 Syntax in-ipa
2269 \end_layout
2270
2271 \begin_layout Description
2272 Origin spitz, 20 May 2012
2273 \end_layout
2274
2275 \begin_layout Subsection*
2276 index-insert
2277 \end_layout
2278
2279 \begin_layout Description
2280 Action Inserts Index entry.
2281 \end_layout
2282
2283 \begin_layout Description
2284 Notion It automatically takes the word on the cursor position.
2285 \end_layout
2286
2287 \begin_layout Description
2288 Syntax index-insert [<TYPE:Name>]
2289 \end_layout
2290
2291 \begin_layout Description
2292 Params <TYPE:Name>: name of the index, if multiple indices are defined. With an empty argument, the default index is selected.
2293 \end_layout
2294
2295 \begin_layout Description
2296 Origin leeming, 3 Aug 2000
2297 \end_layout
2298
2299 \begin_layout Subsection*
2300 index-print
2301 \end_layout
2302
2303 \begin_layout Description
2304 Action Inserts list of Index entries on a new page.
2305 \end_layout
2306
2307 \begin_layout Description
2308 Syntax index-print [<TYPE:Name>]
2309 \end_layout
2310
2311 \begin_layout Description
2312 Params <TYPE:Name>: name of the index, if multiple indices are defined. With an empty argument, the default index is selected.
2313 \end_layout
2314
2315 \begin_layout Description
2316 Origin Lgb, 27 Feb 1997
2317 \end_layout
2318
2319 \begin_layout Subsection*
2320 info-insert
2321 \end_layout
2322
2323 \begin_layout Description
2324 Action Displays shortcuts, lyxrc, package and textclass availability and menu information in a non-editable boxed InsetText.
2325 \end_layout
2326
2327 \begin_layout Description
2328 Notion Apart from lfun arguments you can use the following method:
2329 \begin_inset Newline newline
2330 \end_inset
2331
2332 1. input the type and argument of this inset, e.g. "menu paste", in the work area.
2333 \begin_inset Newline newline
2334 \end_inset
2335
2336 2. select the text and run info-insert lfun.
2337 \end_layout
2338
2339 \begin_layout Description
2340 Syntax info-insert <TYPE> <ARG>
2341 \end_layout
2342
2343 \begin_layout Description
2344 Params <TYPE>: date|moddate|fixdate|time|modtime|fixtime|shortcut|shortcuts|lyxrc| lyxinfo|package|textclass|menu|l7n|icon|buffer|vcs
2345 \begin_inset Newline newline
2346 \end_inset
2347
2348 <ARG>: argument for a given type. Look into InsetInfo.h for detailed description.
2349 \begin_inset Newline newline
2350 \end_inset
2351
2352 date: current date (formatted and localized)
2353 \begin_inset Newline newline
2354 \end_inset
2355
2356 moddate: date of last modification (saving) (formatted and localized)
2357 \begin_inset Newline newline
2358 \end_inset
2359
2360 fixdate: a static date (formatted and localized)
2361 \begin_inset Newline newline
2362 \end_inset
2363
2364 time: current time (formatted and localized)
2365 \begin_inset Newline newline
2366 \end_inset
2367
2368 modtime: time of last modification (saving) (formatted and localized)
2369 \begin_inset Newline newline
2370 \end_inset
2371
2372 fixtime: a static time (formatted and localized)
2373 \begin_inset Newline newline
2374 \end_inset
2375
2376 shortcut[s]: name of lfun (e.g math-insert
2377 \backslash
2378 alpha)
2379 \begin_inset Newline newline
2380 \end_inset
2381
2382 lyxrc: name of rc_entry (e.g. bind_file)
2383 \begin_inset Newline newline
2384 \end_inset
2385
2386 lyxinfo: "version" - used version of LyX
2387 \begin_inset Newline newline
2388 \end_inset
2389
2390 package: name of latex package (e.g. listings)
2391 \begin_inset Newline newline
2392 \end_inset
2393
2394 textclass: name of textclass (e.g. article)
2395 \begin_inset Newline newline
2396 \end_inset
2397
2398 menu: name of lfun used in menu
2399 \begin_inset Newline newline
2400 \end_inset
2401
2402 l7n: localizable string.
2403 \begin_inset Newline newline
2404 \end_inset
2405
2406 icon: icon of lfun used in toolbar or direct icon name
2407 \begin_inset Newline newline
2408 \end_inset
2409
2410 buffer: "name"|"name-noext"|"path"|"class" vcs: "tree-revision"|"revision"|"author"|"date"|"time"
2411 \end_layout
2412
2413 \begin_layout Description
2414 Sample command-sequence info-insert buffer path; info-insert buffer name
2415 \end_layout
2416
2417 \begin_layout Description
2418 Origin bpeng, 7 Oct 2007
2419 \end_layout
2420
2421 \begin_layout Subsection*
2422 inset-apply
2423 \end_layout
2424
2425 \begin_layout Description
2426 Action Apply data for an inset.
2427 \end_layout
2428
2429 \begin_layout Description
2430 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.
2431 \end_layout
2432
2433 \begin_layout Description
2434 Syntax inset-apply <ARGS>
2435 \end_layout
2436
2437 \begin_layout Description
2438 Params See LFUN_INSET_INSERT .
2439 \end_layout
2440
2441 \begin_layout Subsection*
2442 inset-begin
2443 \end_layout
2444
2445 \begin_layout Description
2446 Action Move the cursor to the beginning of the current inset if it is not already there. If the cursor is already at the beginning of the current inset, move it to the beginning of the enclosing inset or the main work area, respectively, if there is no enclosing inset.
2447 \end_layout
2448
2449 \begin_layout Description
2450 Syntax inset-begin
2451 \end_layout
2452
2453 \begin_layout Description
2454 Origin lasgouttes, 16 Mar 2009
2455 \end_layout
2456
2457 \begin_layout Subsection*
2458 inset-begin-select
2459 \end_layout
2460
2461 \begin_layout Description
2462 Action Move the cursor to the beginning of the current inset if it is not already there. If the cursor is already at the beginning of the current inset, move it to the beginning of the enclosing inset or the main work area, respectively, if there is no enclosing inset (adding the traversed text to the selection).
2463 \end_layout
2464
2465 \begin_layout Description
2466 Syntax inset-begin-select
2467 \end_layout
2468
2469 \begin_layout Description
2470 Origin lasgouttes, 16 Mar 2009
2471 \end_layout
2472
2473 \begin_layout Subsection*
2474 inset-copy-as
2475 \end_layout
2476
2477 \begin_layout Description
2478 Action Copies the inset to the clipboard as a certain type.
2479 \end_layout
2480
2481 \begin_layout Description
2482 Notion Currently used only for InsetInfo where its content is copied as a text.
2483 \end_layout
2484
2485 \begin_layout Description
2486 Syntax inset-copy-as
2487 \end_layout
2488
2489 \begin_layout Description
2490 Origin vfr, 18 Apr 2010
2491 \end_layout
2492
2493 \begin_layout Subsection*
2494 inset-dissolve
2495 \end_layout
2496
2497 \begin_layout Description
2498 Action Dissolve the current inset into text.
2499 \end_layout
2500
2501 \begin_layout Description
2502 Syntax inset-dissolve [<INSET>]
2503 \end_layout
2504
2505 \begin_layout Description
2506 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.
2507 \begin_inset Newline newline
2508 \end_inset
2509
2510 For values see lyx::InsetLayout::lyxtype_ .
2511 \end_layout
2512
2513 \begin_layout Description
2514 Origin JSpitz, 7 Aug 2006
2515 \end_layout
2516
2517 \begin_layout Subsection*
2518 inset-edit
2519 \end_layout
2520
2521 \begin_layout Description
2522 Action Edit the inset at cursor with an external application, if one is attributed. If the inset is file based, the referenced file is edited. Otherwise, the inset contents is written to a temporary file, the inset is locked, and the temporary file is edited. In this case, LFUN_INSET_END_EDIT must be called to overtake the changes and unlock the inset after editing is finished.
2523 \end_layout
2524
2525 \begin_layout Description
2526 Syntax inset-edit [<INSET_PARAMS>]
2527 \end_layout
2528
2529 \begin_layout Description
2530 Params <INSET_PARAMS>: Parameters for the inset.
2531 \begin_inset Newline newline
2532 \end_inset
2533
2534 Currently only the filename will be considered.
2535 \end_layout
2536
2537 \begin_layout Description
2538 Origin spitz, 27 Apr 2006
2539 \end_layout
2540
2541 \begin_layout Subsection*
2542 inset-end
2543 \end_layout
2544
2545 \begin_layout Description
2546 Action Move the cursor to the end of the current inset if it is not already there. If the cursor is already at the end of the current inset, move it to the end of the enclosing inset or the main work area, respectively, if there is no enclosing inset.
2547 \end_layout
2548
2549 \begin_layout Description
2550 Syntax inset-end
2551 \end_layout
2552
2553 \begin_layout Description
2554 Origin lasgouttes, 16 Mar 2009
2555 \end_layout
2556
2557 \begin_layout Subsection*
2558 inset-end-edit
2559 \end_layout
2560
2561 \begin_layout Description
2562 Action End editing the inset at cursor with an external application. This replaces the inset contents with the contents of the temporary file, deletes the file and unlocks the inset.
2563 \end_layout
2564
2565 \begin_layout Description
2566 Syntax inset-end-edit
2567 \end_layout
2568
2569 \begin_layout Description
2570 Origin gb, 11 Oct 2015
2571 \end_layout
2572
2573 \begin_layout Subsection*
2574 inset-end-select
2575 \end_layout
2576
2577 \begin_layout Description
2578 Action Move the cursor to the end of the current inset if it is not already there. If the cursor is already at the end of the current inset, move it to the end of the enclosing inset or the main work area, respectively, if there is no enclosing inset (adding the traversed text to the selection).
2579 \end_layout
2580
2581 \begin_layout Description
2582 Syntax inset-end-select
2583 \end_layout
2584
2585 \begin_layout Description
2586 Origin lasgouttes, 16 Mar 2009
2587 \end_layout
2588
2589 \begin_layout Subsection*
2590 inset-forall
2591 \end_layout
2592
2593 \begin_layout Description
2594 Action Apply the given commands on insets of a given name.
2595 \end_layout
2596
2597 \begin_layout Description
2598 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 100000. Note also that inset-forall does not update metrics between iterations, which can lead to bugs. This has to be eventually fixed.
2599 \end_layout
2600
2601 \begin_layout Description
2602 Syntax inset-forall <NAME> <LFUN-COMMAND>
2603 \begin_inset Newline newline
2604 \end_inset
2605
2606 <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.
2607 \end_layout
2608
2609 \begin_layout Description
2610 Sample Remove all index insets:
2611 \begin_inset Newline newline
2612 \end_inset
2613
2614 inset-forall Index char-delete-forward force
2615 \begin_inset Newline newline
2616 \end_inset
2617
2618 Close all Notes (also works for a particular branch, for example):
2619 \begin_inset Newline newline
2620 \end_inset
2621
2622 inset-forall Note inset-toggle close
2623 \begin_inset Newline newline
2624 \end_inset
2625
2626 Transform all yellow notes to comments
2627 \begin_inset Newline newline
2628 \end_inset
2629
2630 inset-forall Note:Note inset-modify note Note Comment
2631 \begin_inset Newline newline
2632 \end_inset
2633
2634 Try to put LyX in an infinite loop if there is at least a Note:
2635 \begin_inset Newline newline
2636 \end_inset
2637
2638 inset-forall Note char-backward
2639 \end_layout
2640
2641 \begin_layout Description
2642 Origin lasgouttes, 27 Nov 2009
2643 \end_layout
2644
2645 \begin_layout Subsection*
2646 inset-insert
2647 \end_layout
2648
2649 \begin_layout Description
2650 Action Insert new inset (type given by the parameters).
2651 \end_layout
2652
2653 \begin_layout Description
2654 Syntax inset-insert <INSET> <ARGS>
2655 \end_layout
2656
2657 \begin_layout Description
2658 Params <INSET>: <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|
2659 \begin_inset Newline newline
2660 \end_inset
2661
2662 hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>
2663 \begin_inset Newline newline
2664 \end_inset
2665
2666 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2667 \end_layout
2668
2669 \begin_layout Description
2670 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
2671 \backslash
2672 end_inset
2673 \begin_inset Newline newline
2674 \end_inset
2675
2676 where <label name> is the name of the referenced label and <Format> is one of the following:
2677 \begin_inset Newline newline
2678 \end_inset
2679
2680 ref -- <reference>
2681 \begin_inset Newline newline
2682 \end_inset
2683
2684 eqref -- (<reference>)
2685 \begin_inset Newline newline
2686 \end_inset
2687
2688 pageref -- <page>
2689 \begin_inset Newline newline
2690 \end_inset
2691
2692 vpageref -- on <page>
2693 \begin_inset Newline newline
2694 \end_inset
2695
2696 vref -- <reference> on <page>
2697 \begin_inset Newline newline
2698 \end_inset
2699
2700 formatted -- Formatted reference
2701 \end_layout
2702
2703 \begin_layout Subsection*
2704 inset-modify
2705 \end_layout
2706
2707 \begin_layout Description
2708 Action Modify some properties of an inset.
2709 \end_layout
2710
2711 \begin_layout Description
2712 Notion Used for argument, bibitem, bibtex, box, branch, caption, citation, command, ert, external, float, graphics, include, index, info, label, line, listings, newline, newpage, nomencl, note, phantom, quotes, ref, script, separator, space, tabular, vspace and wrap insets.
2713 \end_layout
2714
2715 \begin_layout Description
2716 Syntax inset-modify <INSET> <ARGS>
2717 \begin_inset Newline newline
2718 \end_inset
2719
2720 inset-modify changetype <TYPE>
2721 \end_layout
2722
2723 \begin_layout Description
2724 Sample Change a Note inset into a Comment inset:
2725 \begin_inset Newline newline
2726 \end_inset
2727
2728 inset-modify note Note Comment
2729 \begin_inset Newline newline
2730 \end_inset
2731
2732 Change a Box into an Ovalbox:
2733 \begin_inset Newline newline
2734 \end_inset
2735
2736 inset-modify changetype Ovalbox
2737 \begin_inset Newline newline
2738 \end_inset
2739
2740 Change a quotation mark to e[nglish style], l[eft side = opening], s[ingle = inner, secondary]
2741 \begin_inset Newline newline
2742 \end_inset
2743
2744 inset-modify changetype els
2745 \begin_inset Newline newline
2746 \end_inset
2747
2748 Change only the style of a quotation mark, maintaining the other aspects (. = wildcard)
2749 \begin_inset Newline newline
2750 \end_inset
2751
2752 inset-modify changetype e..
2753 \begin_inset Newline newline
2754 \end_inset
2755
2756
2757 \end_layout
2758
2759 \begin_layout Subsection*
2760 inset-select-all
2761 \end_layout
2762
2763 \begin_layout Description
2764 Action Select all contents of an inset.
2765 \end_layout
2766
2767 \begin_layout Description
2768 Notion There are 3 successive levels: select current cell, select all cells of inset, select the inset from outside (in the enclosing inset).
2769 \end_layout
2770
2771 \begin_layout Description
2772 Syntax inset-select-all
2773 \end_layout
2774
2775 \begin_layout Description
2776 Origin vfr, 22 Aug 2009; lasgouttes 1 Nov 2014
2777 \end_layout
2778
2779 \begin_layout Subsection*
2780 inset-settings
2781 \end_layout
2782
2783 \begin_layout Description
2784 Action Open the inset's properties dialog.
2785 \end_layout
2786
2787 \begin_layout Description
2788 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.
2789 \end_layout
2790
2791 \begin_layout Description
2792 Syntax inset-settings <INSET>
2793 \end_layout
2794
2795 \begin_layout Description
2796 Params <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
2797 \begin_inset Newline newline
2798 \end_inset
2799
2800 graphics|href|include|index|index_print|label|line|
2801 \begin_inset Newline newline
2802 \end_inset
2803
2804 listings|note|phantom|ref|space|tabular|vspace|wrap>.
2805 \end_layout
2806
2807 \begin_layout Subsection*
2808 inset-split
2809 \end_layout
2810
2811 \begin_layout Description
2812 Action Splits the current inset into two at current position.
2813 \end_layout
2814
2815 \begin_layout Description
2816 Syntax inset-split [<INSET>]
2817 \end_layout
2818
2819 \begin_layout Description
2820 Params <INSET>: this can be used to make sure the right kind of inset                   is dissolved. For example "split" entry in the charstyles                       sub-menu should only dissolve the charstyle inset, even if the                  cursor is inside several nested insets of different type.
2821 \begin_inset Newline newline
2822 \end_inset
2823
2824                         For values see lyx::InsetLayout::lyxtype_ .
2825 \end_layout
2826
2827 \begin_layout Description
2828 Origin spitz, 22 Dec 2020
2829 \end_layout
2830
2831 \begin_layout Subsection*
2832 inset-toggle
2833 \end_layout
2834
2835 \begin_layout Description
2836 Action Toggles the collapsible inset at cursor position, or the inset we are currently in.
2837 \end_layout
2838
2839 \begin_layout Description
2840 Syntax inset-toggle [<ARG>]
2841 \end_layout
2842
2843 \begin_layout Description
2844 Params <ARG>: <open|close|toggle|assign>.
2845 \begin_inset Newline newline
2846 \end_inset
2847
2848 open/close/toggle are for collapsible insets. toggle is used when no argument is given.
2849 \begin_inset Newline newline
2850 \end_inset
2851
2852 assign synchronize the branch-inset with activation status of the branch. Used for global toggling when changed activation.
2853 \end_layout
2854
2855 \begin_layout Description
2856 Origin lasgouttes, 19 Jul 2001
2857 \end_layout
2858
2859 \begin_layout Subsection*
2860 ipa-insert
2861 \end_layout
2862
2863 \begin_layout Description
2864 Action Inserts an IPA inset.
2865 \end_layout
2866
2867 \begin_layout Description
2868 Syntax ipa-insert
2869 \end_layout
2870
2871 \begin_layout Description
2872 Origin spitz, 05 Mar 2012
2873 \end_layout
2874
2875 \begin_layout Subsection*
2876 ipamacro-insert
2877 \end_layout
2878
2879 \begin_layout Description
2880 Action Inserts special IPA macros into the document.
2881 \end_layout
2882
2883 \begin_layout Description
2884 Syntax ipamacro-insert <CHAR>
2885 \end_layout
2886
2887 \begin_layout Description
2888 Params <CHAR>: tone-falling, tone-rising, tone-high-rising, tone-low-rising, tone-high-rising-falling, deco bottomtiebar, deco toptiebar.
2889 \end_layout
2890
2891 \begin_layout Description
2892 Origin spitz, 22 Aug 2012
2893 \end_layout
2894
2895 \begin_layout Subsection*
2896 keymap-off
2897 \end_layout
2898
2899 \begin_layout Description
2900 Action Turn off the loaded keyboard map.
2901 \end_layout
2902
2903 \begin_layout Description
2904 Syntax keymap-off
2905 \end_layout
2906
2907 \begin_layout Subsection*
2908 keymap-primary
2909 \end_layout
2910
2911 \begin_layout Description
2912 Action Turn on the primary keyboard map.
2913 \end_layout
2914
2915 \begin_layout Description
2916 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 platforms.
2917 \begin_inset Newline newline
2918 \end_inset
2919
2920 The language is to be set in the Preferences dialog.
2921 \end_layout
2922
2923 \begin_layout Description
2924 Syntax keymap-primary
2925 \end_layout
2926
2927 \begin_layout Subsection*
2928 keymap-secondary
2929 \end_layout
2930
2931 \begin_layout Description
2932 Action Turn on the secondary keyboard map.
2933 \end_layout
2934
2935 \begin_layout Description
2936 Syntax keymap-secondary
2937 \end_layout
2938
2939 \begin_layout Subsection*
2940 keymap-toggle
2941 \end_layout
2942
2943 \begin_layout Description
2944 Action Toggles keyboard maps (first/second/off).
2945 \end_layout
2946
2947 \begin_layout Description
2948 Syntax keymap-toggle
2949 \end_layout
2950
2951 \begin_layout Description
2952 Origin leeming, 30 Mar 2004
2953 \end_layout
2954
2955 \begin_layout Subsection*
2956 label-copy-as-reference
2957 \end_layout
2958
2959 \begin_layout Description
2960 Action Copies the label at the cursor as a cross-reference to be pasted elsewhere.
2961 \end_layout
2962
2963 \begin_layout Description
2964 Syntax copy-label-as-reference <LABEL>
2965 \end_layout
2966
2967 \begin_layout Description
2968 Params <LABEL>: The label to copy (for multi-line math)
2969 \end_layout
2970
2971 \begin_layout Description
2972 Origin sts, 16 Nov 2008
2973 \end_layout
2974
2975 \begin_layout Subsection*
2976 label-goto
2977 \end_layout
2978
2979 \begin_layout Description
2980 Action Goto a label.
2981 \end_layout
2982
2983 \begin_layout Description
2984 Syntax label-goto [<LABEL>]
2985 \end_layout
2986
2987 \begin_layout Description
2988 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.
2989 \end_layout
2990
2991 \begin_layout Description
2992 Origin Ale, 6 Aug 1997
2993 \end_layout
2994
2995 \begin_layout Subsection*
2996 label-insert
2997 \end_layout
2998
2999 \begin_layout Description
3000 Action Inserts label to text or displayed formula.
3001 \end_layout
3002
3003 \begin_layout Description
3004 Syntax label-insert [<LABEL>]
3005 \end_layout
3006
3007 \begin_layout Description
3008 Params <LABEL>: Requested label. If no label is given dialog requesting name will be opened.
3009 \end_layout
3010
3011 \begin_layout Subsection*
3012 label-insert-as-reference
3013 \end_layout
3014
3015 \begin_layout Description
3016 Action Inserts the label (in ToC pane) as a cross-reference at the position of the cursor.
3017 \end_layout
3018
3019 \begin_layout Description
3020 Syntax label-insert-as-reference
3021 \end_layout
3022
3023 \begin_layout Description
3024 Origin vfr, 7 Apr 2009
3025 \end_layout
3026
3027 \begin_layout Subsection*
3028 language
3029 \end_layout
3030
3031 \begin_layout Description
3032 Action Set language from the current cursor position.
3033 \end_layout
3034
3035 \begin_layout Description
3036 Syntax language <LANG> [set]
3037 \end_layout
3038
3039 \begin_layout Description
3040 Params <LANG>: Requested language. Look in lib/languages for the list. "language reset" or "language" (without param) reset to the document language. set: If used, the language will be set to the specified language. Otherwise, the language will be toggled (i.e., if the current language is LANG, switch to the document language or the default language, if LANG is the document language).
3041 \end_layout
3042
3043 \begin_layout Description
3044 Origin Dekel, 2 Mar 2000
3045 \end_layout
3046
3047 \begin_layout Subsection*
3048 line-begin
3049 \end_layout
3050
3051 \begin_layout Description
3052 Action Move the cursor to the beginning of the (screen) line.
3053 \end_layout
3054
3055 \begin_layout Description
3056 Syntax line-begin
3057 \end_layout
3058
3059 \begin_layout Subsection*
3060 line-begin-select
3061 \end_layout
3062
3063 \begin_layout Description
3064 Action Move the cursor to the beginning of the (screen) line adding the traversed text to the selection.
3065 \end_layout
3066
3067 \begin_layout Description
3068 Syntax line-begin-select
3069 \end_layout
3070
3071 \begin_layout Subsection*
3072 line-delete-forward
3073 \end_layout
3074
3075 \begin_layout Description
3076 Action Deletes the letters to the end of the (screen) line or deletes the selection.
3077 \end_layout
3078
3079 \begin_layout Description
3080 Syntax line-delete-forward
3081 \end_layout
3082
3083 \begin_layout Subsection*
3084 line-end
3085 \end_layout
3086
3087 \begin_layout Description
3088 Action Move the cursor to the end of the (screen) line.
3089 \end_layout
3090
3091 \begin_layout Description
3092 Syntax line-end
3093 \end_layout
3094
3095 \begin_layout Subsection*
3096 line-end-select
3097 \end_layout
3098
3099 \begin_layout Description
3100 Action Move the cursor to the end of the (screen) line adding the traversed text to the selection.
3101 \end_layout
3102
3103 \begin_layout Description
3104 Syntax line-end-select
3105 \end_layout
3106
3107 \begin_layout Subsection*
3108 listing-insert
3109 \end_layout
3110
3111 \begin_layout Description
3112 Action Inserts a new listings inset.
3113 \end_layout
3114
3115 \begin_layout Description
3116 Syntax listing-insert
3117 \end_layout
3118
3119 \begin_layout Description
3120 Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
3121 \end_layout
3122
3123 \begin_layout Subsection*
3124 marginalnote-insert
3125 \end_layout
3126
3127 \begin_layout Description
3128 Action Inserts a marginal note.
3129 \end_layout
3130
3131 \begin_layout Description
3132 Syntax marginalnote-insert
3133 \end_layout
3134
3135 \begin_layout Description
3136 Origin Lgb, 26 Jun 2000
3137 \end_layout
3138
3139 \begin_layout Subsection*
3140 mark-off
3141 \end_layout
3142
3143 \begin_layout Description
3144 Action Disable selecting of text-region.
3145 \end_layout
3146
3147 \begin_layout Description
3148 Syntax mark-off
3149 \end_layout
3150
3151 \begin_layout Subsection*
3152 mark-on
3153 \end_layout
3154
3155 \begin_layout Description
3156 Action Enable selecting of text-region.
3157 \end_layout
3158
3159 \begin_layout Description
3160 Notion After enabling you can simply move arrow keys to get selected region.
3161 \end_layout
3162
3163 \begin_layout Description
3164 Syntax mark-on
3165 \end_layout
3166
3167 \begin_layout Subsection*
3168 mark-toggle
3169 \end_layout
3170
3171 \begin_layout Description
3172 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
3173 \end_layout
3174
3175 \begin_layout Description
3176 Syntax mark-toggle
3177 \end_layout
3178
3179 \begin_layout Description
3180 Origin Andre, May 5 2006
3181 \end_layout
3182
3183 \begin_layout Subsection*
3184 newline-insert
3185 \end_layout
3186
3187 \begin_layout Description
3188 Action Inserts a line break or new line.
3189 \end_layout
3190
3191 \begin_layout Description
3192 Syntax newline-insert [<ARG>]
3193 \end_layout
3194
3195 \begin_layout Description
3196 Params <ARG>: <newline|linebreak> default: newline
3197 \end_layout
3198
3199 \begin_layout Description
3200 Origin spitz, 25 Mar 2008
3201 \end_layout
3202
3203 \begin_layout Subsection*
3204 newpage-insert
3205 \end_layout
3206
3207 \begin_layout Description
3208 Action Inserts a new page.
3209 \end_layout
3210
3211 \begin_layout Description
3212 Syntax newpage-insert <ARG>
3213 \end_layout
3214
3215 \begin_layout Description
3216 Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
3217 \end_layout
3218
3219 \begin_layout Description
3220 Origin uwestoehr, 24 Nov 2007
3221 \end_layout
3222
3223 \begin_layout Subsection*
3224 nomencl-insert
3225 \end_layout
3226
3227 \begin_layout Description
3228 Action Inserts Nomenclature entry.
3229 \end_layout
3230
3231 \begin_layout Description
3232 Notion It automatically takes the word on the cursor position if no symbol is given.
3233 \end_layout
3234
3235 \begin_layout Description
3236 Syntax nomencl-insert [<SYMBOL>]
3237 \end_layout
3238
3239 \begin_layout Description
3240 Origin Ugras, 4 Nov 2006
3241 \end_layout
3242
3243 \begin_layout Subsection*
3244 nomencl-print
3245 \end_layout
3246
3247 \begin_layout Description
3248 Action Inserts list of Nomenclature entries.
3249 \end_layout
3250
3251 \begin_layout Description
3252 Syntax nomenclature-print
3253 \end_layout
3254
3255 \begin_layout Description
3256 Origin Ugras, 4 Nov 2006
3257 \end_layout
3258
3259 \begin_layout Subsection*
3260 note-insert
3261 \end_layout
3262
3263 \begin_layout Description
3264 Action Inserts Note on the current cursor position, move selection inside the inset.
3265 \end_layout
3266
3267 \begin_layout Description
3268 Syntax note-insert [<TYPE>]
3269 \end_layout
3270
3271 \begin_layout Description
3272 Params <TYPE>: <Note|Greyedout|Comment> default: Note
3273 \end_layout
3274
3275 \begin_layout Subsection*
3276 note-next
3277 \end_layout
3278
3279 \begin_layout Description
3280 Action Moves the cursor to the beginning of next Note inset.
3281 \end_layout
3282
3283 \begin_layout Description
3284 Syntax note-next
3285 \end_layout
3286
3287 \begin_layout Subsection*
3288 outline-down
3289 \end_layout
3290
3291 \begin_layout Description
3292 Action Move the current group in the downward direction in the structure of the document.
3293 \end_layout
3294
3295 \begin_layout Description
3296 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
3297 \end_layout
3298
3299 \begin_layout Description
3300 Syntax outline-down
3301 \end_layout
3302
3303 \begin_layout Description
3304 Origin Vermeer, 23 Mar 2006
3305 \end_layout
3306
3307 \begin_layout Subsection*
3308 outline-in
3309 \end_layout
3310
3311 \begin_layout Description
3312 Action Moves the current group in the downward direction in the hierarchy of the document structure.
3313 \end_layout
3314
3315 \begin_layout Description
3316 Notion Part -> Chapter -> Section -> etc.
3317 \end_layout
3318
3319 \begin_layout Description
3320 Syntax outline-in
3321 \end_layout
3322
3323 \begin_layout Description
3324 Origin Vermeer, 23 Mar 2006
3325 \end_layout
3326
3327 \begin_layout Subsection*
3328 outline-out
3329 \end_layout
3330
3331 \begin_layout Description
3332 Action Moves the current group in the upward direction in the hierarchy of the document structure.
3333 \end_layout
3334
3335 \begin_layout Description
3336 Notion Part <- Chapter <- Section <- etc.
3337 \end_layout
3338
3339 \begin_layout Description
3340 Syntax outline-out
3341 \end_layout
3342
3343 \begin_layout Description
3344 Origin Vermeer, 23 Mar 2006
3345 \end_layout
3346
3347 \begin_layout Subsection*
3348 outline-up
3349 \end_layout
3350
3351 \begin_layout Description
3352 Action Move the current group in the upward direction in the structure of the document.
3353 \end_layout
3354
3355 \begin_layout Description
3356 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
3357 \end_layout
3358
3359 \begin_layout Description
3360 Syntax outline-up
3361 \end_layout
3362
3363 \begin_layout Description
3364 Origin Vermeer, 23 Mar 2006
3365 \end_layout
3366
3367 \begin_layout Subsection*
3368 paragraph-break
3369 \end_layout
3370
3371 \begin_layout Description
3372 Action Breaks the current paragraph at the current location.
3373 \end_layout
3374
3375 \begin_layout Description
3376 Notion Removes the selection.
3377 \end_layout
3378
3379 \begin_layout Description
3380 Syntax paragraph-break [<LAYOUT>] [ignoresep]
3381 \end_layout
3382
3383 \begin_layout Description
3384 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to default layout) when the cursor is at the end of the line.
3385 \begin_inset Newline newline
3386 \end_inset
3387
3388 ignoresep: Do not account for paragraph separators while breaking.
3389 \end_layout
3390
3391 \begin_layout Subsection*
3392 paragraph-down
3393 \end_layout
3394
3395 \begin_layout Description
3396 Action Move the cursor to the next paragraph (or beginning of the current one) in downward direction.
3397 \end_layout
3398
3399 \begin_layout Description
3400 Syntax paragraph-down
3401 \end_layout
3402
3403 \begin_layout Description
3404 Origin Asger, 1 Oct 1996
3405 \end_layout
3406
3407 \begin_layout Subsection*
3408 paragraph-down-select
3409 \end_layout
3410
3411 \begin_layout Description
3412 Action Move the cursor and select the text to the next paragraph (or beginning of the current one) in downward direction.
3413 \end_layout
3414
3415 \begin_layout Description
3416 Syntax paragraph-down-select
3417 \end_layout
3418
3419 \begin_layout Description
3420 Origin Asger, 1 Oct 1996
3421 \end_layout
3422
3423 \begin_layout Subsection*
3424 paragraph-goto
3425 \end_layout
3426
3427 \begin_layout Description
3428 Action Jump to a paragraph given by its id number and optionally the desired position within the paragraph. If given four arguments id_start, pos_start, id_end, pos_end, perform a selection from start to end.
3429 \end_layout
3430
3431 \begin_layout Description
3432 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). Both ids must belong to the same buffer.
3433 \end_layout
3434
3435 \begin_layout Description
3436 Syntax paragraph-goto <PAR_ID> <POS_IN_PAR> [<PAR_ID> <POS_IN_PAR>]
3437 \end_layout
3438
3439 \begin_layout Description
3440 Params <PAR_ID>:  paragraph id
3441 \begin_inset Newline newline
3442 \end_inset
3443
3444 <POS_IN_PAR>: desired position within the paragraph
3445 \end_layout
3446
3447 \begin_layout Description
3448 Origin Dekel, 26 Aug 2000 gmunch, 5 Sep 2016
3449 \end_layout
3450
3451 \begin_layout Subsection*
3452 paragraph-move-down
3453 \end_layout
3454
3455 \begin_layout Description
3456 Action Moves the current paragraph downwards in the document.
3457 \end_layout
3458
3459 \begin_layout Description
3460 Syntax paragraph-move-down
3461 \end_layout
3462
3463 \begin_layout Description
3464 Origin Edwin, 8 Apr 2006
3465 \end_layout
3466
3467 \begin_layout Subsection*
3468 paragraph-move-up
3469 \end_layout
3470
3471 \begin_layout Description
3472 Action Moves the current paragraph upwards in the document.
3473 \end_layout
3474
3475 \begin_layout Description
3476 Notion Movement through the document will possibly break the paragraph-depth (e.g. itemize structure).
3477 \end_layout
3478
3479 \begin_layout Description
3480 Syntax paragraph-move-up
3481 \end_layout
3482
3483 \begin_layout Description
3484 Origin Edwin, 8 Apr 2006
3485 \end_layout
3486
3487 \begin_layout Subsection*
3488 paragraph-params
3489 \end_layout
3490
3491 \begin_layout Description
3492 Action Change paragraph settings.
3493 \end_layout
3494
3495 \begin_layout Description
3496 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.
3497 \end_layout
3498
3499 \begin_layout Description
3500 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
3501 \end_layout
3502
3503 \begin_layout Description
3504 Params <INDENT>:
3505 \backslash
3506 noindent|
3507 \backslash
3508 indent|
3509 \backslash
3510 indent-toggle|
3511 \backslash
3512 leftindent LENGTH
3513 \begin_inset Newline newline
3514 \end_inset
3515
3516 <SPACING>:
3517 \backslash
3518 paragraph_spacing default|single|onehalf|double|other SIZE
3519 \begin_inset Newline newline
3520 \end_inset
3521
3522 <ALIGN>:
3523 \backslash
3524 align block|left|right|center|default
3525 \begin_inset Newline newline
3526 \end_inset
3527
3528 <OTHERS>:
3529 \backslash
3530 labelwidthstring WIDTH|
3531 \backslash
3532 start_of_appendix
3533 \end_layout
3534
3535 \begin_layout Description
3536 Origin rgh, Aug 15 2007
3537 \end_layout
3538
3539 \begin_layout Subsection*
3540 paragraph-params-apply
3541 \end_layout
3542
3543 \begin_layout Description
3544 Action Change paragraph settings.
3545 \end_layout
3546
3547 \begin_layout Description
3548 Notion Overwrite all nonspecified settings to the default ones. Use paragraph-params lfun if you don't want to overwrite others settings.
3549 \end_layout
3550
3551 \begin_layout Description
3552 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
3553 \end_layout
3554
3555 \begin_layout Description
3556 Params For parameters see LFUN_PARAGRAPH_PARAMS
3557 \end_layout
3558
3559 \begin_layout Description
3560 Origin leeming, 30 Mar 2004
3561 \end_layout
3562
3563 \begin_layout Subsection*
3564 paragraph-select
3565 \end_layout
3566
3567 \begin_layout Description
3568 Action Move cursor to beginning of current paragraph and select to the end in downward direction
3569 \end_layout
3570
3571 \begin_layout Description
3572 Notion This function is by default bound to triple mouse click
3573 \end_layout
3574
3575 \begin_layout Description
3576 Syntax paragraph-select
3577 \end_layout
3578
3579 \begin_layout Description
3580 Origin Kornel, 16 Apr 2019
3581 \end_layout
3582
3583 \begin_layout Subsection*
3584 paragraph-up
3585 \end_layout
3586
3587 \begin_layout Description
3588 Action Move the cursor to the next paragraph (or beginning of the current one) in upward direction.
3589 \end_layout
3590
3591 \begin_layout Description
3592 Syntax paragraph-up
3593 \end_layout
3594
3595 \begin_layout Description
3596 Origin Asger, 1 Oct 1996
3597 \end_layout
3598
3599 \begin_layout Subsection*
3600 paragraph-up-select
3601 \end_layout
3602
3603 \begin_layout Description
3604 Action Move the cursor and select the text to the next paragraph (or beginning of the current one) in upward direction.
3605 \end_layout
3606
3607 \begin_layout Description
3608 Syntax paragraph-up-select
3609 \end_layout
3610
3611 \begin_layout Description
3612 Origin Asger, 1 Oct 1996
3613 \end_layout
3614
3615 \begin_layout Subsection*
3616 paste
3617 \end_layout
3618
3619 \begin_layout Description
3620 Action Pastes material (text or picture) from the active clipboard.
3621 \end_layout
3622
3623 \begin_layout Description
3624 Syntax paste [<TYPE>|<NUM>]
3625 \end_layout
3626
3627 \begin_layout Description
3628 Params <TYPE>: emf|pdf|png|jpeg|linkback|wmf|latex|html
3629 \begin_inset Newline newline
3630 \end_inset
3631
3632 <NUM>: number of the selection in the internal clipboard stack to be pasted.
3633 \end_layout
3634
3635 \begin_layout Subsection*
3636 phantom-insert
3637 \end_layout
3638
3639 \begin_layout Description
3640 Action Inserts phantom on the current cursor position, move selection inside the inset.
3641 \end_layout
3642
3643 \begin_layout Description
3644 Syntax phantom-insert [<TYPE>]
3645 \end_layout
3646
3647 \begin_layout Description
3648 Params <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
3649 \end_layout
3650
3651 \begin_layout Description
3652 Origin uwestoehr, 30 Jan 2009
3653 \end_layout
3654
3655 \begin_layout Subsection*
3656 preview-insert
3657 \end_layout
3658
3659 \begin_layout Description
3660 Action Inserts a new preview inset.
3661 \end_layout
3662
3663 \begin_layout Description
3664 Syntax preview-insert
3665 \end_layout
3666
3667 \begin_layout Description
3668 Origin vfr, 28 Mar 2010
3669 \end_layout
3670
3671 \begin_layout Subsection*
3672 primary-selection-paste
3673 \end_layout
3674
3675 \begin_layout Description
3676 Action Pastes the currently selected text.
3677 \end_layout
3678
3679 \begin_layout Description
3680 Notion Primary selection mechanism is linux-only thing.
3681 \end_layout
3682
3683 \begin_layout Description
3684 Syntax primary-selection-paste [<ARG>]
3685 \end_layout
3686
3687 \begin_layout Description
3688 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
3689 \end_layout
3690
3691 \begin_layout Subsection*
3692 quote-insert
3693 \end_layout
3694
3695 \begin_layout Description
3696 Action Inserts quotes according to the type and quote-language preference.
3697 \end_layout
3698
3699 \begin_layout Description
3700 Notion Currently 15 different quote styles are distinguished (see params).
3701 \end_layout
3702
3703 \begin_layout Description
3704 Syntax quote-insert [<LEVEL>] [<SIDE>] [<STYLE>]
3705 \end_layout
3706
3707 \begin_layout Description
3708 Params <LEVEL>: 'inner' for (i.e., secondary, usually single) quotes, otherwise outer (i.e., primary, usually double) quotes will be used.
3709 \begin_inset Newline newline
3710 \end_inset
3711
3712 <SIDE>:  'opening' for opening quotes, 'closing' for closing quotes, otherwise the side will be guessed from the context.
3713 \begin_inset Newline newline
3714 \end_inset
3715
3716 <STYLE>: 'british' for `British' quote style (with ``inner quotation'')
3717 \begin_inset Newline newline
3718 \end_inset
3719
3720 'cjk' for Chinese/Japanese/Korean corner bracket quotation marks
3721 \begin_inset Newline newline
3722 \end_inset
3723
3724 'cjk-angle' for Chinese/Japanese/Korean angle bracket quotation marks
3725 \begin_inset Newline newline
3726 \end_inset
3727
3728 'danish' for >>Danish<< quote style (with >inner quotation<)
3729 \begin_inset Newline newline
3730 \end_inset
3731
3732 'english' for ``English'' quote style (with `inner quotation')
3733 \begin_inset Newline newline
3734 \end_inset
3735
3736 'french' for <<french>> quote style (with ``inner quotation'')
3737 \begin_inset Newline newline
3738 \end_inset
3739
3740 'frenchin' for <<frenchin>> quote style (with <<inner quotation>>) ["in" = Imprimerie Nationale]
3741 \begin_inset Newline newline
3742 \end_inset
3743
3744 'german' for ,,German`` quote style (with ,inner quotation`)
3745 \begin_inset Newline newline
3746 \end_inset
3747
3748 'plain' for "Plain" quote style (with 'inner quotation')
3749 \begin_inset Newline newline
3750 \end_inset
3751
3752 'polish' for ,,Polish'' quote style (with ,inner quotation')
3753 \begin_inset Newline newline
3754 \end_inset
3755
3756 'swedish' for ''Swedish'' quote style (with 'inner quotation')
3757 \begin_inset Newline newline
3758 \end_inset
3759
3760 'swedishg' for >>swedishg>> quote style (with 'inner quotation') ["g" = Guillemets]
3761 \begin_inset Newline newline
3762 \end_inset
3763
3764 'swiss' for <<Swiss>> quote style (with <inner quotation>)
3765 \begin_inset Newline newline
3766 \end_inset
3767
3768 'russian' for <<Russian>> quote style (with ,,inner quotation``)
3769 \begin_inset Newline newline
3770 \end_inset
3771
3772 'dynamic' for Dynamic quotation marks which inherit the global document style
3773 \begin_inset Newline newline
3774 \end_inset
3775
3776 If no quote style is specified, the document-wide will be used.
3777 \end_layout
3778
3779 \begin_layout Subsection*
3780 redo
3781 \end_layout
3782
3783 \begin_layout Description
3784 Action Redoes the last thing undone.
3785 \end_layout
3786
3787 \begin_layout Description
3788 Syntax redo
3789 \end_layout
3790
3791 \begin_layout Subsection*
3792 reference-next
3793 \end_layout
3794
3795 \begin_layout Description
3796 Action Go to the next label or cross-reference.
3797 \end_layout
3798
3799 \begin_layout Description
3800 Syntax reference-next
3801 \end_layout
3802
3803 \begin_layout Description
3804 Origin Dekel, 14 Jan 2001
3805 \end_layout
3806
3807 \begin_layout Subsection*
3808 repeat
3809 \end_layout
3810
3811 \begin_layout Description
3812 Action Repeat the given command.
3813 \end_layout
3814
3815 \begin_layout Description
3816 Notion fails when the repeat count is greater than 10000.
3817 \end_layout
3818
3819 \begin_layout Description
3820 Syntax repeat <COUNT> <LFUN-COMMAND>
3821 \end_layout
3822
3823 \begin_layout Description
3824 Origin Andre, 27 Oct 2003
3825 \end_layout
3826
3827 \begin_layout Subsection*
3828 screen-down
3829 \end_layout
3830
3831 \begin_layout Description
3832 Action Moves the cursor one page in downward direction.
3833 \end_layout
3834
3835 \begin_layout Description
3836 Syntax screen-down
3837 \end_layout
3838
3839 \begin_layout Subsection*
3840 screen-down-select
3841 \end_layout
3842
3843 \begin_layout Description
3844 Action Moves the cursor one screen in downward direction adding the current position to the selection.
3845 \end_layout
3846
3847 \begin_layout Description
3848 Syntax screen-down-select
3849 \end_layout
3850
3851 \begin_layout Subsection*
3852 screen-recenter
3853 \end_layout
3854
3855 \begin_layout Description
3856 Action Recenters the screen on the current cursor position.
3857 \end_layout
3858
3859 \begin_layout Description
3860 Syntax screen-recenter
3861 \end_layout
3862
3863 \begin_layout Subsection*
3864 screen-show-cursor
3865 \end_layout
3866
3867 \begin_layout Description
3868 Action Repositions the screen such that the cursor is visible.
3869 \end_layout
3870
3871 \begin_layout Description
3872 Syntax screen-show-cursor
3873 \end_layout
3874
3875 \begin_layout Description
3876 Origin vfr, 25 Mar 2009
3877 \end_layout
3878
3879 \begin_layout Subsection*
3880 screen-up
3881 \end_layout
3882
3883 \begin_layout Description
3884 Action Moves the cursor one page in upward direction.
3885 \end_layout
3886
3887 \begin_layout Description
3888 Syntax screen-up
3889 \end_layout
3890
3891 \begin_layout Subsection*
3892 screen-up-select
3893 \end_layout
3894
3895 \begin_layout Description
3896 Action Moves the cursor one page in upward direction adding the current position to the selection.
3897 \end_layout
3898
3899 \begin_layout Description
3900 Syntax screen-up-select
3901 \end_layout
3902
3903 \begin_layout Subsection*
3904 script-insert
3905 \end_layout
3906
3907 \begin_layout Description
3908 Action Inserts a subscript or superscript inset.
3909 \end_layout
3910
3911 \begin_layout Description
3912 Syntax script-insert <TYPE>
3913 \end_layout
3914
3915 \begin_layout Description
3916 Params <TYPE>: subscript|superscript
3917 \end_layout
3918
3919 \begin_layout Description
3920 Origin Georg, 23 Nov 2010
3921 \end_layout
3922
3923 \begin_layout Subsection*
3924 scroll
3925 \end_layout
3926
3927 \begin_layout Description
3928 Action Scroll the buffer view.
3929 \end_layout
3930
3931 \begin_layout Description
3932 Notion Only scrolls the screen up or down; does not move the cursor.
3933 \end_layout
3934
3935 \begin_layout Description
3936 Syntax scroll <TYPE> <QUANTITY>
3937 \end_layout
3938
3939 \begin_layout Description
3940 Params <TYPE>:  line|page
3941 \begin_inset Newline newline
3942 \end_inset
3943
3944 <QUANTITY>: up|down|<number>
3945 \end_layout
3946
3947 \begin_layout Description
3948 Origin Abdel, Dec 27 2007
3949 \end_layout
3950
3951 \begin_layout Subsection*
3952 section-select
3953 \end_layout
3954
3955 \begin_layout Description
3956 Action Select the whole section.
3957 \end_layout
3958
3959 \begin_layout Description
3960 Notion The cursor should be in a section heading before calling this lfun.
3961 \end_layout
3962
3963 \begin_layout Description
3964 Syntax section-select
3965 \end_layout
3966
3967 \begin_layout Description
3968 Origin vfr, 05 May 2009
3969 \end_layout
3970
3971 \begin_layout Subsection*
3972 selection-paste
3973 \end_layout
3974
3975 \begin_layout Description
3976 Action Pastes the internal selection text in permanent selection.
3977 \end_layout
3978
3979 \begin_layout Description
3980 Notion Created in order to have middle mouse button pasting correct (bound to command-alternatives selection-paste ; primary-selection-paste paragraph).
3981 \end_layout
3982
3983 \begin_layout Description
3984 Syntax selection-paste
3985 \end_layout
3986
3987 \begin_layout Description
3988 Origin lasgouttes, 14 Jan 2009
3989 \end_layout
3990
3991 \begin_layout Subsection*
3992 separator-insert
3993 \end_layout
3994
3995 \begin_layout Description
3996 Action Inserts an environment separator or latex paragraph break.
3997 \end_layout
3998
3999 \begin_layout Description
4000 Syntax separator-insert [<ARG>]
4001 \end_layout
4002
4003 \begin_layout Description
4004 Params <ARG>: <plain|parbreak|latexpar> default: plain
4005 \end_layout
4006
4007 \begin_layout Description
4008 Origin ef, 2 May 2014
4009 \end_layout
4010
4011 \begin_layout Subsection*
4012 space-insert
4013 \end_layout
4014
4015 \begin_layout Description
4016 Action Inserts one of horizontal space insets.
4017 \end_layout
4018
4019 \begin_layout Description
4020 Syntax space-insert <NAME> [<LEN>]
4021 \end_layout
4022
4023 \begin_layout Description
4024 Params <NAME>: normal, protected, visible, thin, quad, qquad, enspace, enskip, negthinspace, negmedspace, negthickspace, hfill, hfill*, dotfill, hrulefill, hspace, hspace*
4025 \begin_inset Newline newline
4026 \end_inset
4027
4028 Only in math mode: med and thick.
4029 \begin_inset Newline newline
4030 \end_inset
4031
4032 <LEN>: length for custom spaces (hspace, hspace* for protected)
4033 \end_layout
4034
4035 \begin_layout Description
4036 Origin spitz, 20 May 2003, Mar 17 2008
4037 \end_layout
4038
4039 \begin_layout Subsection*
4040 specialchar-insert
4041 \end_layout
4042
4043 \begin_layout Description
4044 Action Inserts various characters into the document.
4045 \end_layout
4046
4047 \begin_layout Description
4048 Syntax specialchar-insert <CHAR>
4049 \end_layout
4050
4051 \begin_layout Description
4052 Params <CHAR>: hyphenation, allowbreak, ligature-break, slash, nobreakdash, dots, end-of-sentence, menu-separator, lyx, tex, latex, latex2e.
4053 \end_layout
4054
4055 \begin_layout Description
4056 Origin spitz, 6 Dec 2007
4057 \end_layout
4058
4059 \begin_layout Subsection*
4060 spelling-add
4061 \end_layout
4062
4063 \begin_layout Description
4064 Action Add the word under the cursor to the respective spell checker dictionary. The default for the language is retrieved from the cursor position.
4065 \end_layout
4066
4067 \begin_layout Description
4068 Syntax spelling-add [<STRING>] [<LANG>]
4069 \end_layout
4070
4071 \begin_layout Description
4072 Params <WORD>: word to add <LANG>: language name (see file languages)
4073 \end_layout
4074
4075 \begin_layout Description
4076 Origin spitz, 18 Jan 2010
4077 \end_layout
4078
4079 \begin_layout Subsection*
4080 spelling-continuously
4081 \end_layout
4082
4083 \begin_layout Description
4084 Action Toggle continuous spell checking.
4085 \end_layout
4086
4087 \begin_layout Description
4088 Syntax spelling-continuously
4089 \end_layout
4090
4091 \begin_layout Description
4092 Origin vfr, 24 March 2013
4093 \end_layout
4094
4095 \begin_layout Subsection*
4096 spelling-ignore
4097 \end_layout
4098
4099 \begin_layout Description
4100 Action Let the spell checker ignore the word under the cursor in the current session for the given language. The default for the language is retrieved from the cursor position.
4101 \end_layout
4102
4103 \begin_layout Description
4104 Syntax spelling-ignore [<WORD>] [<LANG>]
4105 \end_layout
4106
4107 \begin_layout Description
4108 Params <WORD>: word to ignore <LANG>: language name (see file languages)
4109 \end_layout
4110
4111 \begin_layout Description
4112 Origin spitz, 18 Jan 2010
4113 \end_layout
4114
4115 \begin_layout Subsection*
4116 spelling-remove
4117 \end_layout
4118
4119 \begin_layout Description
4120 Action Remove the word under the cursor from the respective spell checker dictionary. The default for the language is retrieved from the cursor position.
4121 \end_layout
4122
4123 \begin_layout Description
4124 Syntax spelling-remove [<STRING>] [<LANG>]
4125 \end_layout
4126
4127 \begin_layout Description
4128 Params <WORD>: word to remove <LANG>: language name (see file languages)
4129 \end_layout
4130
4131 \begin_layout Description
4132 Origin SWitt, 28 July 2010
4133 \end_layout
4134
4135 \begin_layout Subsection*
4136 tab-delete
4137 \end_layout
4138
4139 \begin_layout Description
4140 Action Delete a tab or up to an equivalent amount of spaces from a listings inset.
4141 \end_layout
4142
4143 \begin_layout Description
4144 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.
4145 \end_layout
4146
4147 \begin_layout Description
4148 Syntax tab-delete
4149 \end_layout
4150
4151 \begin_layout Description
4152 Origin vfr, Sep 30 2008
4153 \end_layout
4154
4155 \begin_layout Subsection*
4156 tab-insert
4157 \end_layout
4158
4159 \begin_layout Description
4160 Action Insert a tab into a listings inset.
4161 \end_layout
4162
4163 \begin_layout Description
4164 Notion It also works on a selection.
4165 \end_layout
4166
4167 \begin_layout Description
4168 Syntax tab-insert
4169 \end_layout
4170
4171 \begin_layout Description
4172 Origin vfr, Sep 30 2008
4173 \end_layout
4174
4175 \begin_layout Subsection*
4176 tabular-feature
4177 \end_layout
4178
4179 \begin_layout Description
4180 Action Modify properties of tabulars and table-like math environments.
4181 \end_layout
4182
4183 \begin_layout Description
4184 Syntax tabular-feature <FEATURE> [<ARG>]
4185 \end_layout
4186
4187 \begin_layout Description
4188 Params Generally see LFUN_INSET_INSERT for further details.
4189 \begin_inset Newline newline
4190 \end_inset
4191
4192 <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|
4193 \begin_inset Newline newline
4194 \end_inset
4195
4196 copy-column|move-column-right|move-column-left|move-row-down|move-row-up|
4197 \begin_inset Newline newline
4198 \end_inset
4199
4200 set-line-top|set-line-bottom|set-line-left|set-line-right|
4201 \begin_inset Newline newline
4202 \end_inset
4203
4204 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
4205 \begin_inset Newline newline
4206 \end_inset
4207
4208 set-ltrim-top|set-rtrim-top|set-ltrim-bottom|set-rtrim-bottom
4209 \begin_inset Newline newline
4210 \end_inset
4211
4212 toggle-ltrim-top|toggle-rtrim-top|toggle-ltrim-bottom|toggle-rtrim-bottom
4213 \begin_inset Newline newline
4214 \end_inset
4215
4216 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|
4217 \begin_inset Newline newline
4218 \end_inset
4219
4220 valign-top|valign-bottom|valign-middle|longtabular-align-left|
4221 \begin_inset Newline newline
4222 \end_inset
4223
4224 longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|
4225 \begin_inset Newline newline
4226 \end_inset
4227
4228 m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|
4229 \begin_inset Newline newline
4230 \end_inset
4231
4232 reset-formal-default|set-all-lines|unset-all-lines|toggle-longtabular|
4233 \begin_inset Newline newline
4234 \end_inset
4235
4236 set-longtabular|unset-longtabular|set-pwidth|
4237 \begin_inset Newline newline
4238 \end_inset
4239
4240 set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
4241 \begin_inset Newline newline
4242 \end_inset
4243
4244 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
4245 \begin_inset Newline newline
4246 \end_inset
4247
4248 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
4249 \begin_inset Newline newline
4250 \end_inset
4251
4252 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
4253 \begin_inset Newline newline
4254 \end_inset
4255
4256 set-special-column|set-special-multicolumn|set-special-multirow|
4257 \begin_inset Newline newline
4258 \end_inset
4259
4260 toggle-booktabs|set-booktabs|unset-booktabs|set-top-space|set-bottom-space|
4261 \begin_inset Newline newline
4262 \end_inset
4263
4264 set-interline-space|set-border-lines|tabular-valign-top|
4265 \begin_inset Newline newline
4266 \end_inset
4267
4268 tabular-valign-middle|tabular-valign-bottom|set-tabular-width|
4269 \begin_inset Newline newline
4270 \end_inset
4271
4272 toggle-varwidth-column Various math-environment features are handled as well, e.g. add-vline-left/right for
4273 \begin_inset Newline newline
4274 \end_inset
4275
4276 the Grid/Array environment.
4277 \begin_inset Newline newline
4278 \end_inset
4279
4280 <ARG>: additional argument for some commands, use debug mode to explore its values.
4281 \end_layout
4282
4283 \begin_layout Description
4284 Origin gm, 10 Dec 2015
4285 \end_layout
4286
4287 \begin_layout Subsection*
4288 tabular-insert
4289 \end_layout
4290
4291 \begin_layout Description
4292 Action Inserts table into the document.
4293 \end_layout
4294
4295 \begin_layout Description
4296 Notion See LFUN_TABULAR_FEATURE for some more details about tabular modifications.
4297 \end_layout
4298
4299 \begin_layout Description
4300 Syntax tabular-insert [<ROWS> <COLUMNS>]
4301 \end_layout
4302
4303 \begin_layout Description
4304 Params In case no arguments are given show insert dialog.
4305 \end_layout
4306
4307 \begin_layout Description
4308 Origin Jug, 12 Apr 2000
4309 \end_layout
4310
4311 \begin_layout Subsection*
4312 tabular-style-insert
4313 \end_layout
4314
4315 \begin_layout Description
4316 Action Inserts table of a given style into the document.
4317 \end_layout
4318
4319 \begin_layout Description
4320 Notion See LFUN_TABULAR_FEATURE for some more details          about tabular modifications.
4321 \end_layout
4322
4323 \begin_layout Description
4324 Syntax tabular-style-insert <style> <ROWS> <COLUMNS>
4325 \end_layout
4326
4327 \begin_layout Description
4328 Params Valid styles are the names of the files in lib/tabletemplates, minus _1x<n> and .lyx suffix.
4329 \end_layout
4330
4331 \begin_layout Description
4332 Origin spitz, 25 Mar 2019
4333 \end_layout
4334
4335 \begin_layout Subsection*
4336 thesaurus-entry
4337 \end_layout
4338
4339 \begin_layout Description
4340 Action Look up thesaurus entries with respect to the word under the cursor.
4341 \end_layout
4342
4343 \begin_layout Description
4344 Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
4345 \end_layout
4346
4347 \begin_layout Description
4348 Params <STRING>: word to look up <LANG>: language (see file languages)
4349 \end_layout
4350
4351 \begin_layout Description
4352 Origin Levon, 20 Jul 2001
4353 \end_layout
4354
4355 \begin_layout Subsection*
4356 undo
4357 \end_layout
4358
4359 \begin_layout Description
4360 Action Undoes the last edit.
4361 \end_layout
4362
4363 \begin_layout Description
4364 Syntax undo
4365 \end_layout
4366
4367 \begin_layout Subsection*
4368 unicode-insert
4369 \end_layout
4370
4371 \begin_layout Description
4372 Action Inserts a single unicode character.
4373 \end_layout
4374
4375 \begin_layout Description
4376 Syntax unicode-insert <CHAR1> <CHAR2> ...
4377 \end_layout
4378
4379 \begin_layout Description
4380 Params <CHARn>: The character to insert, given as its code point, in hexadecimal.
4381 \end_layout
4382
4383 \begin_layout Description
4384 Sample unicode-insert 0x0100 0x0259
4385 \end_layout
4386
4387 \begin_layout Description
4388 Origin Lgb, 22 Oct 2006
4389 \end_layout
4390
4391 \begin_layout Subsection*
4392 up
4393 \end_layout
4394
4395 \begin_layout Description
4396 Action Moves the cursor one line in upward direction.
4397 \end_layout
4398
4399 \begin_layout Description
4400 Syntax up
4401 \end_layout
4402
4403 \begin_layout Subsection*
4404 up-select
4405 \end_layout
4406
4407 \begin_layout Description
4408 Action Moves the cursor one line in upward direction adding the current position to the selection.
4409 \end_layout
4410
4411 \begin_layout Description
4412 Syntax up-select
4413 \end_layout
4414
4415 \begin_layout Subsection*
4416 word-backward
4417 \end_layout
4418
4419 \begin_layout Description
4420 Action Moves the cursor to the logically previous beginning of a word.
4421 \end_layout
4422
4423 \begin_layout Description
4424 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.
4425 \end_layout
4426
4427 \begin_layout Description
4428 Syntax word-backward
4429 \end_layout
4430
4431 \begin_layout Subsection*
4432 word-backward-select
4433 \end_layout
4434
4435 \begin_layout Description
4436 Action Moves the cursor to the logically previous beginning of a word, adding the logically traversed text to the selection.
4437 \end_layout
4438
4439 \begin_layout Description
4440 Notion See also LFUN_WORD_BACKWARD.
4441 \end_layout
4442
4443 \begin_layout Description
4444 Syntax word-backward-select
4445 \end_layout
4446
4447 \begin_layout Subsection*
4448 word-capitalize
4449 \end_layout
4450
4451 \begin_layout Description
4452 Action Capitalizes the words in the selection (i.e. the first letters) or the first letter of word at cursor position.
4453 \end_layout
4454
4455 \begin_layout Description
4456 Syntax word-capitalize [<SEL_TYPE>]
4457 \end_layout
4458
4459 \begin_layout Description
4460 Params <SEL_TYPE>: if this is equal to "partial", then the default word starts at cursor position (emacs-style). Otherwise, the whole word is considered.
4461 \end_layout
4462
4463 \begin_layout Subsection*
4464 word-delete-backward
4465 \end_layout
4466
4467 \begin_layout Description
4468 Action Deletes characters to the beginning of the word (usually the "C+BackSpace" key).
4469 \end_layout
4470
4471 \begin_layout Description
4472 Syntax word-delete-backward [force]
4473 \end_layout
4474
4475 \begin_layout Description
4476 Params force: Delete big insets, do not only select them.
4477 \end_layout
4478
4479 \begin_layout Subsection*
4480 word-delete-forward
4481 \end_layout
4482
4483 \begin_layout Description
4484 Action Deletes characters to the end of the word (usually the "C+Delete" key).
4485 \end_layout
4486
4487 \begin_layout Description
4488 Syntax word-delete-forward [force]
4489 \end_layout
4490
4491 \begin_layout Description
4492 Params force: Delete big insets, do not only select them.
4493 \end_layout
4494
4495 \begin_layout Subsection*
4496 word-find
4497 \end_layout
4498
4499 \begin_layout Description
4500 Action Search for next occurrence of a string.
4501 \end_layout
4502
4503 \begin_layout Description
4504 Syntax word-find [<DATA>]
4505 \end_layout
4506
4507 \begin_layout Description
4508 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).
4509 \end_layout
4510
4511 \begin_layout Description
4512 Origin Andre, Jan 7 2004
4513 \end_layout
4514
4515 \begin_layout Subsection*
4516 word-find-backward
4517 \end_layout
4518
4519 \begin_layout Description
4520 Action Search for a given string in backward direction.
4521 \end_layout
4522
4523 \begin_layout Description
4524 Notion Case sensitive, match words. If no argument given, last search repeated.
4525 \end_layout
4526
4527 \begin_layout Description
4528 Syntax word-find-backward [<STRING>]
4529 \end_layout
4530
4531 \begin_layout Description
4532 Origin Etienne, 20 Feb 1998
4533 \end_layout
4534
4535 \begin_layout Subsection*
4536 word-find-forward
4537 \end_layout
4538
4539 \begin_layout Description
4540 Action Search for a given string in forward direction.
4541 \end_layout
4542
4543 \begin_layout Description
4544 Notion Case sensitive, match words. If no argument given, last search repeated.
4545 \end_layout
4546
4547 \begin_layout Description
4548 Syntax word-find-forward [<STRING>]
4549 \end_layout
4550
4551 \begin_layout Description
4552 Origin Etienne, 16 Feb 1998
4553 \end_layout
4554
4555 \begin_layout Subsection*
4556 word-findadv
4557 \end_layout
4558
4559 \begin_layout Description
4560 Action Search for next occurrence of a pattern.
4561 \end_layout
4562
4563 \begin_layout Description
4564 Syntax word-findadv [<DATA>]
4565 \end_layout
4566
4567 \begin_layout Description
4568 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).
4569 \end_layout
4570
4571 \begin_layout Description
4572 Origin Tommaso, Nov 15 2007
4573 \end_layout
4574
4575 \begin_layout Subsection*
4576 word-forward
4577 \end_layout
4578
4579 \begin_layout Description
4580 Action Moves the cursor to the logically next beginning of a word.
4581 \end_layout
4582
4583 \begin_layout Description
4584 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.
4585 \end_layout
4586
4587 \begin_layout Description
4588 Syntax word-forward
4589 \end_layout
4590
4591 \begin_layout Subsection*
4592 word-forward-select
4593 \end_layout
4594
4595 \begin_layout Description
4596 Action Moves the cursor to the logically next beginning of a word, adding the logically traversed text to the selection.
4597 \end_layout
4598
4599 \begin_layout Description
4600 Notion See also LFUN_WORD_FORWARD.
4601 \end_layout
4602
4603 \begin_layout Description
4604 Syntax word-forward-select
4605 \end_layout
4606
4607 \begin_layout Subsection*
4608 word-left
4609 \end_layout
4610
4611 \begin_layout Description
4612 Action Moves the cursor to the next beginning of a word "on the left".
4613 \end_layout
4614
4615 \begin_layout Description
4616 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.
4617 \end_layout
4618
4619 \begin_layout Description
4620 Syntax word-left
4621 \end_layout
4622
4623 \begin_layout Description
4624 Origin dov, 28 Oct 2007
4625 \end_layout
4626
4627 \begin_layout Subsection*
4628 word-left-select
4629 \end_layout
4630
4631 \begin_layout Description
4632 Action Moves the cursor to the next beginning of a word "on the left", adding *logically* traversed text to the selection.
4633 \end_layout
4634
4635 \begin_layout Description
4636 Notion See also LFUN_WORD_LEFT for exact details of the movement.
4637 \end_layout
4638
4639 \begin_layout Description
4640 Syntax word-left-select
4641 \end_layout
4642
4643 \begin_layout Description
4644 Origin dov, 28 Oct 2007
4645 \end_layout
4646
4647 \begin_layout Subsection*
4648 word-lowcase
4649 \end_layout
4650
4651 \begin_layout Description
4652 Action Change the words in the selection or word at cursor position to lower case.
4653 \end_layout
4654
4655 \begin_layout Description
4656 Syntax word-lowcase [<SEL_TYPE>]
4657 \end_layout
4658
4659 \begin_layout Description
4660 Params <SEL_TYPE>: if this is equal to "partial", then the default word starts at cursor position (emacs-style). Otherwise, the whole word is considered.
4661 \end_layout
4662
4663 \begin_layout Subsection*
4664 word-replace
4665 \end_layout
4666
4667 \begin_layout Description
4668 Action Replace a string in the document.
4669 \end_layout
4670
4671 \begin_layout Description
4672 Syntax word-replace [<DATA>]
4673 \end_layout
4674
4675 \begin_layout Description
4676 Params <DATA>: data is of the form "<replacestring>
4677 \begin_inset Newline newline
4678 \end_inset
4679
4680 <searchstring>
4681 \begin_inset Newline newline
4682 \end_inset
4683
4684 <casesensitive> <matchword> <all> <forward> <findnext>"
4685 \end_layout
4686
4687 \begin_layout Description
4688 Origin Andre, Jan 7 2004
4689 \end_layout
4690
4691 \begin_layout Subsection*
4692 word-right
4693 \end_layout
4694
4695 \begin_layout Description
4696 Action Moves the cursor to the next beginning of a word "on the right".
4697 \end_layout
4698
4699 \begin_layout Description
4700 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.
4701 \end_layout
4702
4703 \begin_layout Description
4704 Syntax word-right
4705 \end_layout
4706
4707 \begin_layout Description
4708 Origin dov, 28 Oct 2007
4709 \end_layout
4710
4711 \begin_layout Subsection*
4712 word-right-select
4713 \end_layout
4714
4715 \begin_layout Description
4716 Action Moves the cursor to the next beginning of a word "on the right", adding *logically* traversed text to the selection.
4717 \end_layout
4718
4719 \begin_layout Description
4720 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
4721 \end_layout
4722
4723 \begin_layout Description
4724 Syntax word-right-select
4725 \end_layout
4726
4727 \begin_layout Description
4728 Origin dov, 28 Oct 2007
4729 \end_layout
4730
4731 \begin_layout Subsection*
4732 word-select
4733 \end_layout
4734
4735 \begin_layout Description
4736 Action Puts the word where the cursor stands into the selection.
4737 \end_layout
4738
4739 \begin_layout Description
4740 Syntax word-select
4741 \end_layout
4742
4743 \begin_layout Description
4744 Origin Andre, 11 Sep 2002
4745 \end_layout
4746
4747 \begin_layout Subsection*
4748 word-upcase
4749 \end_layout
4750
4751 \begin_layout Description
4752 Action Change the words in the selection or word at cursor position to upper case.
4753 \end_layout
4754
4755 \begin_layout Description
4756 Syntax word-upcase [<SEL_TYPE>]
4757 \end_layout
4758
4759 \begin_layout Description
4760 Params <SEL_TYPE>: if this is equal to "partial", then the default word starts at cursor position (emacs-style). Otherwise, the whole word is considered.
4761 \end_layout
4762
4763 \begin_layout Subsection*
4764 wrap-insert
4765 \end_layout
4766
4767 \begin_layout Description
4768 Action Inserts floats wrapped by the text around.
4769 \end_layout
4770
4771 \begin_layout Description
4772 Syntax wrap-insert <TYPE>
4773 \end_layout
4774
4775 \begin_layout Description
4776 Params <TYPE>: table|figure
4777 \end_layout
4778
4779 \begin_layout Description
4780 Origin Dekel, 7 Apr 2002
4781 \end_layout
4782
4783 \begin_layout Section
4784 Math Editor Functions
4785 \end_layout
4786
4787 \begin_layout Subsection*
4788 in-mathmacrotemplate
4789 \end_layout
4790
4791 \begin_layout Description
4792 Action Only active in Math Macro definition.
4793 \end_layout
4794
4795 \begin_layout Description
4796 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.
4797 \end_layout
4798
4799 \begin_layout Description
4800 Syntax in-mathmacrotemplate
4801 \end_layout
4802
4803 \begin_layout Description
4804 Origin sts, 06 January 2008
4805 \end_layout
4806
4807 \begin_layout Subsection*
4808 math-ams-matrix
4809 \end_layout
4810
4811 \begin_layout Description
4812 Action Inserts an extended matrix as provided by the amsmath package.
4813 \end_layout
4814
4815 \begin_layout Description
4816 Syntax math-matrix <COLS> <ROWS> [<DECORATION>]
4817 \end_layout
4818
4819 \begin_layout Description
4820 Params <DECORATION>: Decoration determines the LaTeX name of the matrix that should be created. Possible values include pmatrix, bmatrix, Bmatrix, vmatrix, Vmatrix, smallmatrix, and matrix. The default is 'matrix'.
4821 \end_layout
4822
4823 \begin_layout Description
4824 Sample math-ams-matrix 3 3 bmatrix
4825 \end_layout
4826
4827 \begin_layout Subsection*
4828 math-bigdelim
4829 \end_layout
4830
4831 \begin_layout Description
4832 Action Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
4833 \end_layout
4834
4835 \begin_layout Description
4836 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
4837 \end_layout
4838
4839 \begin_layout Description
4840 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
4841 \begin_inset Newline newline
4842 \end_inset
4843
4844 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
4845 \end_layout
4846
4847 \begin_layout Description
4848 Sample math-bigdelim "Bigl" "
4849 \backslash
4850 Downarrow" "Bigr" "
4851 \backslash
4852 }"
4853 \end_layout
4854
4855 \begin_layout Description
4856 Origin Enrico & Georg, 7 May 2006
4857 \end_layout
4858
4859 \begin_layout Subsection*
4860 math-delim
4861 \end_layout
4862
4863 \begin_layout Description
4864 Action Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
4865 \end_layout
4866
4867 \begin_layout Description
4868 Syntax math-delim [<LEFT>] [<RIGHT>]
4869 \end_layout
4870
4871 \begin_layout Description
4872 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.
4873 \end_layout
4874
4875 \begin_layout Description
4876 Sample math-delim { rangle
4877 \end_layout
4878
4879 \begin_layout Description
4880 Origin Alejandro, 18 Jun 1996
4881 \end_layout
4882
4883 \begin_layout Subsection*
4884 math-display
4885 \end_layout
4886
4887 \begin_layout Description
4888 Action Creates a new displayed equation in text mode. Toggles inlined/display formula in math mode.
4889 \end_layout
4890
4891 \begin_layout Description
4892 Syntax math-display [<ARG>]
4893 \end_layout
4894
4895 \begin_layout Description
4896 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating new equation from the text mode.
4897 \end_layout
4898
4899 \begin_layout Description
4900 Origin Alejandro, 18 Jun 1996
4901 \end_layout
4902
4903 \begin_layout Subsection*
4904 math-extern
4905 \end_layout
4906
4907 \begin_layout Description
4908 Action Calls external program and passes the current expression/equation as an argument for the calculation in the format appropriate to the given language.
4909 \end_layout
4910
4911 \begin_layout Description
4912 Notion Selection can be used to determine the input for the external program.
4913 \end_layout
4914
4915 \begin_layout Description
4916 Syntax math-extern <LANG> [<COMMAND>]
4917 \end_layout
4918
4919 \begin_layout Description
4920 Params <LANG>: octave|maxima|maple|mathematica|script
4921 \begin_inset Newline newline
4922 \end_inset
4923
4924 where "script" stands for the external script (normalized expression will be passed)
4925 \end_layout
4926
4927 \begin_layout Description
4928 Sample math-extern maple simplify
4929 \end_layout
4930
4931 \begin_layout Description
4932 Origin Andre, 24 Apr 2001
4933 \end_layout
4934
4935 \begin_layout Subsection*
4936 math-font-style
4937 \end_layout
4938
4939 \begin_layout Description
4940 Action Changes the text style used in math.
4941 \end_layout
4942
4943 \begin_layout Description
4944 Syntax math-font-style <STYLE>
4945 \end_layout
4946
4947 \begin_layout Description
4948 Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal
4949 \begin_inset Newline newline
4950 \end_inset
4951
4952 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
4953 \end_layout
4954
4955 \begin_layout Description
4956 Origin vfr, 9 jan 2009
4957 \end_layout
4958
4959 \begin_layout Subsection*
4960 math-insert
4961 \end_layout
4962
4963 \begin_layout Description
4964 Action Inserts math objects and symbols.
4965 \end_layout
4966
4967 \begin_layout Description
4968 Notion When <ARG> is a _single_ math inset with more than one cell (such as "x_y^z" or "
4969 \backslash
4970 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
4971 \backslash
4972 frac{x}{y}" replaces "abc" with "
4973 \backslash
4974 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.
4975 \end_layout
4976
4977 \begin_layout Description
4978 Syntax math-insert <ARG>
4979 \end_layout
4980
4981 \begin_layout Description
4982 Params <ARG>: Symbol or LaTeX code to be inserted.
4983 \end_layout
4984
4985 \begin_layout Subsection*
4986 math-limits
4987 \end_layout
4988
4989 \begin_layout Description
4990 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.
4991 \end_layout
4992
4993 \begin_layout Description
4994 Notion Put the cursor before the symbol with the limits and then invoke math-limits.
4995 \end_layout
4996
4997 \begin_layout Description
4998 Syntax math-limits [<STATE>]
4999 \end_layout
5000
5001 \begin_layout Description
5002 Params <STATE>: limits|nolimits
5003 \end_layout
5004
5005 \begin_layout Subsection*
5006 math-macro
5007 \end_layout
5008
5009 \begin_layout Description
5010 Action Inserts a math macro definition at the cursor position in the text.
5011 \end_layout
5012
5013 \begin_layout Description
5014 Syntax math-macro <NAME> [<NARGS>] [def]
5015 \end_layout
5016
5017 \begin_layout Description
5018 Params <NAME>: The name of the macro, e.g. "mymacro".
5019 \begin_inset Newline newline
5020 \end_inset
5021
5022 <NARGS>: The number of parameters of the macro. Default is 0. "def": Has no effect anymore, just for compatibility with former LyX versions.
5023 \end_layout
5024
5025 \begin_layout Description
5026 Origin ale, 10 May 1997;  sts, 21 Dec 2007
5027 \end_layout
5028
5029 \begin_layout Subsection*
5030 math-macro-add-greedy-optional-param
5031 \end_layout
5032
5033 \begin_layout Description
5034 Action Add a greedy optional parameter.
5035 \end_layout
5036
5037 \begin_layout Description
5038 Notion Add a greedy optional parameter which eats the value from the following cells in mathed which are in the [value] format.
5039 \end_layout
5040
5041 \begin_layout Description
5042 Syntax math-macro-add-greedy-optional-param
5043 \end_layout
5044
5045 \begin_layout Description
5046 Origin sts, 06 January 2008
5047 \end_layout
5048
5049 \begin_layout Subsection*
5050 math-macro-add-optional-param
5051 \end_layout
5052
5053 \begin_layout Description
5054 Action Add an optional parameter.
5055 \end_layout
5056
5057 \begin_layout Description
5058 Notion Insert an optional parameter just behind the already existing optional parameters.
5059 \end_layout
5060
5061 \begin_layout Description
5062 Syntax math-macro-add-optional-param
5063 \end_layout
5064
5065 \begin_layout Description
5066 Origin sts, 06 January 2008
5067 \end_layout
5068
5069 \begin_layout Subsection*
5070 math-macro-add-param
5071 \end_layout
5072
5073 \begin_layout Description
5074 Action Add a parameter.
5075 \end_layout
5076
5077 \begin_layout Description
5078 Notion Add a parameter to a Math Macro.
5079 \end_layout
5080
5081 \begin_layout Description
5082 Syntax math-macro-add-param <NUM>
5083 \end_layout
5084
5085 \begin_layout Description
5086 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.
5087 \end_layout
5088
5089 \begin_layout Description
5090 Origin sts, 06 January 2008
5091 \end_layout
5092
5093 \begin_layout Subsection*
5094 math-macro-append-greedy-param
5095 \end_layout
5096
5097 \begin_layout Description
5098 Action Append a greedy parameter.
5099 \end_layout
5100
5101 \begin_layout Description
5102 Notion Append a greedy parameter to a Math Macro which eats the following mathed cell in every instance of the macro in the buffer.
5103 \end_layout
5104
5105 \begin_layout Description
5106 Syntax math-macro-append-greedy-param
5107 \end_layout
5108
5109 \begin_layout Description
5110 Origin sts, 06 January 2008
5111 \end_layout
5112
5113 \begin_layout Subsection*
5114 math-macro-fold
5115 \end_layout
5116
5117 \begin_layout Description
5118 Action Fold a Math Macro.
5119 \end_layout
5120
5121 \begin_layout Description
5122 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e. displayed as
5123 \backslash
5124 foo before.
5125 \end_layout
5126
5127 \begin_layout Description
5128 Syntax math-macro-fold
5129 \end_layout
5130
5131 \begin_layout Description
5132 Origin sts, 06 January 2008
5133 \end_layout
5134
5135 \begin_layout Subsection*
5136 math-macro-make-nonoptional
5137 \end_layout
5138
5139 \begin_layout Description
5140 Action Make a parameter non-optional.
5141 \end_layout
5142
5143 \begin_layout Description
5144 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.
5145 \end_layout
5146
5147 \begin_layout Description
5148 Syntax math-macro-make-nonoptional
5149 \end_layout
5150
5151 \begin_layout Description
5152 Origin sts, 06 January 2008
5153 \end_layout
5154
5155 \begin_layout Subsection*
5156 math-macro-make-optional
5157 \end_layout
5158
5159 \begin_layout Description
5160 Action Make a parameter optional.
5161 \end_layout
5162
5163 \begin_layout Description
5164 Notion Turn the first non-optional parameter of a Math Macro into an optional parameter with a default value.
5165 \end_layout
5166
5167 \begin_layout Description
5168 Syntax math-macro-make-optional
5169 \end_layout
5170
5171 \begin_layout Description
5172 Origin sts, 06 January 2008
5173 \end_layout
5174
5175 \begin_layout Subsection*
5176 math-macro-remove-greedy-param
5177 \end_layout
5178
5179 \begin_layout Description
5180 Action Remove a greedy parameter.
5181 \end_layout
5182
5183 \begin_layout Description
5184 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.
5185 \end_layout
5186
5187 \begin_layout Description
5188 Syntax math-macro-remove-greedy-param
5189 \end_layout
5190
5191 \begin_layout Description
5192 Origin sts, 06 January 2008
5193 \end_layout
5194
5195 \begin_layout Subsection*
5196 math-macro-remove-optional-param
5197 \end_layout
5198
5199 \begin_layout Description
5200 Action Remove the last optional parameter.
5201 \end_layout
5202
5203 \begin_layout Description
5204 Notion Remove the last optional parameter of a Math Macro and remove it in all the instances of the macro in the buffer.
5205 \end_layout
5206
5207 \begin_layout Description
5208 Syntax math-macro-remove-optional-param
5209 \end_layout
5210
5211 \begin_layout Description
5212 Origin sts, 06 January 2008
5213 \end_layout
5214
5215 \begin_layout Subsection*
5216 math-macro-remove-param
5217 \end_layout
5218
5219 \begin_layout Description
5220 Action Remove the last parameter.
5221 \end_layout
5222
5223 \begin_layout Description
5224 Notion Remove the last parameter of a Math Macro and remove its value in all instances of the macro in the buffer.
5225 \end_layout
5226
5227 \begin_layout Description
5228 Syntax math-macro-remove-param <NUM>
5229 \end_layout
5230
5231 \begin_layout Description
5232 Params <NUM>: The number of the parameter to be deleted (1 for the first), defaults to the last one.
5233 \end_layout
5234
5235 \begin_layout Description
5236 Origin sts, 06 January 2008
5237 \end_layout
5238
5239 \begin_layout Subsection*
5240 math-macro-unfold
5241 \end_layout
5242
5243 \begin_layout Description
5244 Action Unfold a Math Macro.
5245 \end_layout
5246
5247 \begin_layout Description
5248 Notion Unfold the Math Macro the cursor is in, i.e. display it as
5249 \backslash
5250 foo.
5251 \end_layout
5252
5253 \begin_layout Description
5254 Syntax math-macro-unfold
5255 \end_layout
5256
5257 \begin_layout Description
5258 Origin sts, 06 January 2008
5259 \end_layout
5260
5261 \begin_layout Subsection*
5262 math-matrix
5263 \end_layout
5264
5265 \begin_layout Description
5266 Action Inserts a matrix.
5267 \end_layout
5268
5269 \begin_layout Description
5270 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
5271 \end_layout
5272
5273 \begin_layout Description
5274 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).
5275 \end_layout
5276
5277 \begin_layout Description
5278 Sample math-matrix 3 3 bccc
5279 \end_layout
5280
5281 \begin_layout Subsection*
5282 math-mode
5283 \end_layout
5284
5285 \begin_layout Description
5286 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.
5287 \end_layout
5288
5289 \begin_layout Description
5290 Notion If there is some selected text, it puts the text inside created math box.
5291 \end_layout
5292
5293 \begin_layout Description
5294 Syntax math-mode [on|<ARG>]
5295 \end_layout
5296
5297 \begin_layout Description
5298 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT .
5299 \begin_inset Newline newline
5300 \end_inset
5301
5302 "on": allow only entering of math mode from text mode.
5303 \end_layout
5304
5305 \begin_layout Description
5306 Origin Alejandro, 4 Jun 1996
5307 \end_layout
5308
5309 \begin_layout Subsection*
5310 math-mutate
5311 \end_layout
5312
5313 \begin_layout Description
5314 Action Mutates the type of math inset to the newly selected one.
5315 \end_layout
5316
5317 \begin_layout Description
5318 Syntax math-mutate <TYPE>
5319 \end_layout
5320
5321 \begin_layout Description
5322 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat| multline|gather|flalign
5323 \end_layout
5324
5325 \begin_layout Description
5326 Origin Andre, 23 May 2001
5327 \end_layout
5328
5329 \begin_layout Subsection*
5330 math-number-line-toggle
5331 \end_layout
5332
5333 \begin_layout Description
5334 Action Toggles numbering of the current formula line.
5335 \end_layout
5336
5337 \begin_layout Description
5338 Notion Must be in display formula mode.
5339 \end_layout
5340
5341 \begin_layout Description
5342 Syntax math-number-line-toggle
5343 \end_layout
5344
5345 \begin_layout Description
5346 Origin Alejandro, 18 Jun 1996
5347 \end_layout
5348
5349 \begin_layout Subsection*
5350 math-number-toggle
5351 \end_layout
5352
5353 \begin_layout Description
5354 Action Toggles numbering/labeling of the current formula.
5355 \end_layout
5356
5357 \begin_layout Description
5358 Notion Must be in display formula mode.
5359 \end_layout
5360
5361 \begin_layout Description
5362 Syntax math-number-toggle
5363 \end_layout
5364
5365 \begin_layout Description
5366 Origin Alejandro, 4 Jun 1996
5367 \end_layout
5368
5369 \begin_layout Subsection*
5370 math-size
5371 \end_layout
5372
5373 \begin_layout Description
5374 Action Changes arbitrarily the size used by math fonts inside a context.
5375 \end_layout
5376
5377 \begin_layout Description
5378 Notion Provides an interface to the LaTeX math mode font size commands.
5379 \end_layout
5380
5381 \begin_layout Description
5382 Syntax math-size <STYLE>
5383 \end_layout
5384
5385 \begin_layout Description
5386 Params <STYLE>:
5387 \backslash
5388 displaystyle|
5389 \backslash
5390 textstyle|
5391 \backslash
5392 scriptstyle|
5393 \backslash
5394 scriptscriptstyle
5395 \end_layout
5396
5397 \begin_layout Description
5398 Origin Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
5399 \end_layout
5400
5401 \begin_layout Subsection*
5402 math-space
5403 \end_layout
5404
5405 \begin_layout Description
5406 Action Inserts space into math expression.
5407 \end_layout
5408
5409 \begin_layout Description
5410 Notion Use spacebar after entering this space to change type of space.
5411 \end_layout
5412
5413 \begin_layout Description
5414 Syntax math-space [<TYPE>] [<LEN>]
5415 \end_layout
5416
5417 \begin_layout Description
5418 Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
5419 \begin_inset Newline newline
5420 \end_inset
5421
5422 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
5423 \begin_inset Newline newline
5424 \end_inset
5425
5426 custom space: hspace
5427 \begin_inset Newline newline
5428 \end_inset
5429
5430 "," used by default.
5431 \begin_inset Newline newline
5432 \end_inset
5433
5434 Note that ! is equivalent to negthinspace, , = thinspace, : = medspace, and ; = thickspace.
5435 \begin_inset Newline newline
5436 \end_inset
5437
5438 <LEN>: length for custom spaces (hspace)
5439 \end_layout
5440
5441 \begin_layout Description
5442 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
5443 \end_layout
5444
5445 \begin_layout Subsection*
5446 math-subscript
5447 \end_layout
5448
5449 \begin_layout Description
5450 Action Enters subscript expression in math expression.
5451 \end_layout
5452
5453 \begin_layout Description
5454 Syntax math-subscript
5455 \end_layout
5456
5457 \begin_layout Description
5458 Origin vermeer, 12 Dec 2001
5459 \end_layout
5460
5461 \begin_layout Subsection*
5462 math-superscript
5463 \end_layout
5464
5465 \begin_layout Description
5466 Action Enters superscript expression in math expression.
5467 \end_layout
5468
5469 \begin_layout Description
5470 Syntax math-superscript
5471 \end_layout
5472
5473 \begin_layout Description
5474 Origin vermeer, 12 Dec 2001
5475 \end_layout
5476
5477 \begin_layout Subsection*
5478 regexp-mode
5479 \end_layout
5480
5481 \begin_layout Description
5482 Action Enters regexp mode (i.e., puts regexp insets on the current cursor position). Used by the advanced search dialog.
5483 \end_layout
5484
5485 \begin_layout Description
5486 Notion If there is any selected text, then it is moved inside the created regexp inset.
5487 \end_layout
5488
5489 \begin_layout Description
5490 Syntax regexp-mode [<ARG>]
5491 \end_layout
5492
5493 \begin_layout Description
5494 Params <ARG>: eventual argument (regular expression).
5495 \end_layout
5496
5497 \begin_layout Description
5498 Origin Tommaso, 4 Oct 2008
5499 \end_layout
5500
5501 \begin_layout Section
5502 Buffer Fuctions (File and Window related)
5503 \end_layout
5504
5505 \begin_layout Subsection*
5506 branch-activate
5507 \end_layout
5508
5509 \begin_layout Description
5510 Action Activate the branch.
5511 \end_layout
5512
5513 \begin_layout Description
5514 Syntax branch-activate <BRANCH>
5515 \end_layout
5516
5517 \begin_layout Description
5518 Params <BRANCH>: The branch to activate
5519 \end_layout
5520
5521 \begin_layout Description
5522 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
5523 \begin_inset Newline newline
5524 \end_inset
5525
5526 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
5527 \end_layout
5528
5529 \begin_layout Description
5530 Origin rgh, 27 May 2008
5531 \end_layout
5532
5533 \begin_layout Subsection*
5534 branch-add
5535 \end_layout
5536
5537 \begin_layout Description
5538 Action Add a branch to the buffer's BranchList.
5539 \end_layout
5540
5541 \begin_layout Description
5542 Syntax branch-add <BRANCH>
5543 \end_layout
5544
5545 \begin_layout Description
5546 Params <BRANCH>: Name of the branch to add
5547 \end_layout
5548
5549 \begin_layout Description
5550 Origin spitz, 7 Jul 2009
5551 \end_layout
5552
5553 \begin_layout Subsection*
5554 branch-add-insert
5555 \end_layout
5556
5557 \begin_layout Description
5558 Action Create new branch and directly put the branch inset into the document.
5559 \end_layout
5560
5561 \begin_layout Description
5562 Syntax branch-add-insert [<NAME>]
5563 \end_layout
5564
5565 \begin_layout Description
5566 Params <NAME>: Branch name. If it is not specified, you will be asked.
5567 \end_layout
5568
5569 \begin_layout Description
5570 Origin sanda, 10 Jul 2009
5571 \end_layout
5572
5573 \begin_layout Subsection*
5574 branch-deactivate
5575 \end_layout
5576
5577 \begin_layout Description
5578 Action De-activate the branch.
5579 \end_layout
5580
5581 \begin_layout Description
5582 Syntax branch-deactivate <BRANCH>
5583 \end_layout
5584
5585 \begin_layout Description
5586 Params <BRANCH>: The branch to deactivate
5587 \end_layout
5588
5589 \begin_layout Description
5590 Origin rgh, 27 May 2008
5591 \end_layout
5592
5593 \begin_layout Subsection*
5594 branch-invert
5595 \end_layout
5596
5597 \begin_layout Description
5598 Action Toggles inversion status of branch inset.
5599 \end_layout
5600
5601 \begin_layout Description
5602 Syntax branch-invert
5603 \end_layout
5604
5605 \begin_layout Description
5606 Origin rgheck, 12 July 2016
5607 \end_layout
5608
5609 \begin_layout Subsection*
5610 branch-master-activate
5611 \end_layout
5612
5613 \begin_layout Description
5614 Action Activate the branch in the master buffer.
5615 \end_layout
5616
5617 \begin_layout Description
5618 Syntax branch-master-activate <BRANCH>
5619 \end_layout
5620
5621 \begin_layout Description
5622 Params <BRANCH>: The branch to activate
5623 \end_layout
5624
5625 \begin_layout Description
5626 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
5627 \begin_inset Newline newline
5628 \end_inset
5629
5630 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
5631 \end_layout
5632
5633 \begin_layout Description
5634 Origin spitz, 30 Sep 2012
5635 \end_layout
5636
5637 \begin_layout Subsection*
5638 branch-master-deactivate
5639 \end_layout
5640
5641 \begin_layout Description
5642 Action De-activate the branch in the master buffer.
5643 \end_layout
5644
5645 \begin_layout Description
5646 Syntax branch-master-deactivate <BRANCH>
5647 \end_layout
5648
5649 \begin_layout Description
5650 Params <BRANCH>: The branch to deactivate
5651 \end_layout
5652
5653 \begin_layout Description
5654 Origin spitz, 30 Sep 2012
5655 \end_layout
5656
5657 \begin_layout Subsection*
5658 branches-rename
5659 \end_layout
5660
5661 \begin_layout Description
5662 Action Rename all branches of a given name in a document.
5663 \end_layout
5664
5665 \begin_layout Description
5666 Syntax branches-rename <OLDNAME> <NEWNAME>
5667 \end_layout
5668
5669 \begin_layout Description
5670 Params <OLDNAME>: Current name of the branch to be renamed <NEWNAME>: New name of the branch
5671 \end_layout
5672
5673 \begin_layout Description
5674 Origin spitz, 9 Jul 2009
5675 \end_layout
5676
5677 \begin_layout Subsection*
5678 buffer-auto-save
5679 \end_layout
5680
5681 \begin_layout Description
5682 Action Saves the current buffer to a temporary file.
5683 \end_layout
5684
5685 \begin_layout Description
5686 Notion Saves the current buffer to a file named "#filename#". This LFUN is called automatically by LyX, to "autosave" the current buffer.
5687 \end_layout
5688
5689 \begin_layout Description
5690 Syntax buffer-auto-save
5691 \end_layout
5692
5693 \begin_layout Subsection*
5694 buffer-child-open
5695 \end_layout
5696
5697 \begin_layout Description
5698 Action Loads the given child document.
5699 \end_layout
5700
5701 \begin_layout Description
5702 Notion The current document is treated as a parent.
5703 \end_layout
5704
5705 \begin_layout Description
5706 Syntax buffer-child-open <FILE>
5707 \end_layout
5708
5709 \begin_layout Description
5710 Params <FILE>: Filename of the child. The directory of the parent is assumed by default.
5711 \end_layout
5712
5713 \begin_layout Description
5714 Origin Ale, 28 May 1997
5715 \end_layout
5716
5717 \begin_layout Subsection*
5718 buffer-chktex
5719 \end_layout
5720
5721 \begin_layout Description
5722 Action Runs chktex for the current document.
5723 \end_layout
5724
5725 \begin_layout Description
5726 Syntax buffer-chktex
5727 \end_layout
5728
5729 \begin_layout Description
5730 Origin Asger, 30 Oct 1997
5731 \end_layout
5732
5733 \begin_layout Subsection*
5734 buffer-close
5735 \end_layout
5736
5737 \begin_layout Description
5738 Action Closes the current buffer.
5739 \end_layout
5740
5741 \begin_layout Description
5742 Notion Closes the current buffer, asking whether to save it, etc, if the buffer has been modified.
5743 \end_layout
5744
5745 \begin_layout Description
5746 Syntax buffer-close
5747 \end_layout
5748
5749 \begin_layout Subsection*
5750 buffer-close-all
5751 \end_layout
5752
5753 \begin_layout Description
5754 Action Closes all buffers.
5755 \end_layout
5756
5757 \begin_layout Description
5758 Notion Closes all buffers, asking whether to save it, etc, if a buffer has been modified.
5759 \end_layout
5760
5761 \begin_layout Description
5762 Syntax buffer-close-all
5763 \end_layout
5764
5765 \begin_layout Subsection*
5766 buffer-export
5767 \end_layout
5768
5769 \begin_layout Description
5770 Action Exports the current buffer (document) to the given format.
5771 \end_layout
5772
5773 \begin_layout Description
5774 Syntax buffer-export [<FORMAT>] [<DEST>]
5775 \end_layout
5776
5777 \begin_layout Description
5778 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.
5779 \begin_inset Newline newline
5780 \end_inset
5781
5782 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.
5783 \begin_inset Newline newline
5784 \end_inset
5785
5786 If absent or "default", then the default output format of the document is used.
5787 \begin_inset Newline newline
5788 \end_inset
5789
5790 <DEST>   If present, this argument provides the export destination filename. Its containing folder will also be the destination folder, where all the needed external files will be copied.
5791 \end_layout
5792
5793 \begin_layout Description
5794 Origin Lgb, 29 Jul 1997
5795 \end_layout
5796
5797 \begin_layout Subsection*
5798 buffer-export-as
5799 \end_layout
5800
5801 \begin_layout Description
5802 Action Opens a dialog for exporting the current buffer.
5803 \end_layout
5804
5805 \begin_layout Description
5806 Syntax buffer-export-as [<FORMAT>]
5807 \end_layout
5808
5809 \begin_layout Description
5810 Params <FORMAT> is the export format initially selected in the dialog. You can pass any of the formats which you can find in Tools->Preferences->File formats->Format, provided it has the "document" flag set. If no format is specified the dialog will start with the default output format of the current document.
5811 \end_layout
5812
5813 \begin_layout Description
5814 Sample buffer-export-as pdf2
5815 \end_layout
5816
5817 \begin_layout Description
5818 Origin tommaso, 6 Oct 2011
5819 \end_layout
5820
5821 \begin_layout Subsection*
5822 buffer-export-custom
5823 \end_layout
5824
5825 \begin_layout Description
5826 Action Exports the current buffer (document) from the given format using the given command on it.
5827 \end_layout
5828
5829 \begin_layout Description
5830 Syntax buffer-export-custom <FORMAT> <COMMAND>
5831 \end_layout
5832
5833 \begin_layout Description
5834 Params <FORMAT> format to start from (LyX will care to produce such intermediate file).
5835 \begin_inset Newline newline
5836 \end_inset
5837
5838 <COMMAND> this command will be launched on the file. Note that you can use "$$FName" string to qualify the intermediate file.
5839 \end_layout
5840
5841 \begin_layout Description
5842 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
5843 \end_layout
5844
5845 \begin_layout Description
5846 Origin leeming, 27 Mar 2004
5847 \end_layout
5848
5849 \begin_layout Subsection*
5850 buffer-external-modification-clear
5851 \end_layout
5852
5853 \begin_layout Description
5854 Action Clear the external modification flag on the current buffer.
5855 \end_layout
5856
5857 \begin_layout Description
5858 Syntax buffer-external-modification-clear
5859 \end_layout
5860
5861 \begin_layout Description
5862 Origin gm, 2 March 2017
5863 \end_layout
5864
5865 \begin_layout Subsection*
5866 buffer-forall
5867 \end_layout
5868
5869 \begin_layout Description
5870 Action Applies a command to all non-hidden buffers.
5871 \end_layout
5872
5873 \begin_layout Description
5874 Notion a buffer is `hidden' if it is internally open in LyX, but not visible in any window.
5875 \end_layout
5876
5877 \begin_layout Description
5878 Syntax buffer-forall <LFUN-COMMAND>
5879 \end_layout
5880
5881 \begin_layout Description
5882 Params <LFUN-COMMAND>: The command to be applied to the buffers.
5883 \end_layout
5884
5885 \begin_layout Description
5886 Sample Close all Notes in buffers:
5887 \begin_inset Newline newline
5888 \end_inset
5889
5890 buffer-forall inset-forall Note inset-toggle close
5891 \begin_inset Newline newline
5892 \end_inset
5893
5894 Toggle change tracking on buffers:
5895 \begin_inset Newline newline
5896 \end_inset
5897
5898 buffer-forall changes-track
5899 \begin_inset Newline newline
5900 \end_inset
5901
5902 Toggle read-only for buffers:
5903 \begin_inset Newline newline
5904 \end_inset
5905
5906 buffer-forall buffer-toggle-read-only
5907 \begin_inset Newline newline
5908 \end_inset
5909
5910 Show statistics for individual buffers:
5911 \begin_inset Newline newline
5912 \end_inset
5913
5914 buffer-forall statistics
5915 \begin_inset Newline newline
5916 \end_inset
5917
5918 Activate the branch named "Solutions" in buffers:
5919 \begin_inset Newline newline
5920 \end_inset
5921
5922 buffer-forall branch-activate Solutions
5923 \begin_inset Newline newline
5924 \end_inset
5925
5926 Export buffers to PDF (pdflatex):
5927 \begin_inset Newline newline
5928 \end_inset
5929
5930 buffer-forall buffer-export pdf2
5931 \begin_inset Newline newline
5932 \end_inset
5933
5934
5935 \end_layout
5936
5937 \begin_layout Description
5938 Origin skostysh, 20 Jul 2012
5939 \end_layout
5940
5941 \begin_layout Subsection*
5942 buffer-import
5943 \end_layout
5944
5945 \begin_layout Description
5946 Action Import a given file as a lyx document.
5947 \end_layout
5948
5949 \begin_layout Description
5950 Notion File can be imported iff lyx file format is (transitively) reachable via defined converters in preferences. Look in the File->Import menu to get an idea of the currently active import formats.
5951 \end_layout
5952
5953 \begin_layout Description
5954 Syntax buffer-import <FORMAT> [<FILE>]
5955 \end_layout
5956
5957 \begin_layout Description
5958 Origin Asger, 24 Jul 1998
5959 \end_layout
5960
5961 \begin_layout Subsection*
5962 buffer-language
5963 \end_layout
5964
5965 \begin_layout Description
5966 Action Set language of the current document.
5967 \end_layout
5968
5969 \begin_layout Description
5970 Syntax buffer-language <LANG>
5971 \end_layout
5972
5973 \begin_layout Description
5974 Params <LANG>: language name. See lib/languages for list.
5975 \end_layout
5976
5977 \begin_layout Description
5978 Origin leeming, 30 Mar 2004
5979 \end_layout
5980
5981 \begin_layout Subsection*
5982 buffer-move-next
5983 \end_layout
5984
5985 \begin_layout Description
5986 Action Moves the current tab one spot to the right.
5987 \end_layout
5988
5989 \begin_layout Description
5990 Syntax buffer-move-next
5991 \end_layout
5992
5993 \begin_layout Description
5994 Origin skostysh, 7 Apr 2015
5995 \end_layout
5996
5997 \begin_layout Subsection*
5998 buffer-move-previous
5999 \end_layout
6000
6001 \begin_layout Description
6002 Action Moves the current tab one spot to the left.
6003 \end_layout
6004
6005 \begin_layout Description
6006 Syntax buffer-move-previous
6007 \end_layout
6008
6009 \begin_layout Description
6010 Origin skostysh, 7 Apr 2015
6011 \end_layout
6012
6013 \begin_layout Subsection*
6014 buffer-new
6015 \end_layout
6016
6017 \begin_layout Description
6018 Action Creates a new buffer (that is, document) and switches to it.
6019 \end_layout
6020
6021 \begin_layout Description
6022 Notion Implicit path can be set in Preferences dialog.
6023 \end_layout
6024
6025 \begin_layout Description
6026 Syntax buffer-new [<FILE>]
6027 \end_layout
6028
6029 \begin_layout Description
6030 Params <FILE>: filename of created file with absolute path.
6031 \end_layout
6032
6033 \begin_layout Subsection*
6034 buffer-new-template
6035 \end_layout
6036
6037 \begin_layout Description
6038 Action Creates a new buffer (that is, document) from a template.
6039 \end_layout
6040
6041 \begin_layout Description
6042 Notion Path for new files and templates can be set in Preferences dialog. Template will be asked for via Open-dialog.
6043 \end_layout
6044
6045 \begin_layout Description
6046 Syntax buffer-new-template [<FILE>] [<TEMPLATE FILE>]
6047 \end_layout
6048
6049 \begin_layout Description
6050 Params <FILE>: filename of created file with absolute path. If empty or "newfile", a file with appropriate name is generated. <TEMPLATE FILE>: filename of template with absolute path. If empty, a dialog is opened to select the new file.
6051 \end_layout
6052
6053 \begin_layout Subsection*
6054 buffer-next
6055 \end_layout
6056
6057 \begin_layout Description
6058 Action Switch to the next opened document.
6059 \end_layout
6060
6061 \begin_layout Description
6062 Notion Note that this does not necessarily mean next in tabbar (for full list see View menu).
6063 \end_layout
6064
6065 \begin_layout Description
6066 Syntax buffer-next
6067 \end_layout
6068
6069 \begin_layout Subsection*
6070 buffer-params-apply
6071 \end_layout
6072
6073 \begin_layout Description
6074 Action Apply the given settings to the current document.
6075 \end_layout
6076
6077 \begin_layout Description
6078 Syntax buffer-params-apply [<ARGS>]
6079 \end_layout
6080
6081 \begin_layout Description
6082 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
6083 \end_layout
6084
6085 \begin_layout Description
6086 Origin leeming, 30 Mar 2004
6087 \end_layout
6088
6089 \begin_layout Subsection*
6090 buffer-previous
6091 \end_layout
6092
6093 \begin_layout Description
6094 Action Switch to the previous opened document.
6095 \end_layout
6096
6097 \begin_layout Description
6098 Syntax buffer-previous
6099 \end_layout
6100
6101 \begin_layout Subsection*
6102 buffer-reload
6103 \end_layout
6104
6105 \begin_layout Description
6106 Action Reverts opened document.
6107 \end_layout
6108
6109 \begin_layout Description
6110 Syntax buffer-reload [dump]
6111 \end_layout
6112
6113 \begin_layout Description
6114 Params dump: do not ask for any confirmation, just reload. All changes will be lost.
6115 \end_layout
6116
6117 \begin_layout Description
6118 Origin Asger, 2 Feb 1997
6119 \end_layout
6120
6121 \begin_layout Subsection*
6122 buffer-reset-export
6123 \end_layout
6124
6125 \begin_layout Description
6126 Action Removes the auxiliary file before next export to assure export is done afresh.
6127 \end_layout
6128
6129 \begin_layout Description
6130 Syntax buffer-reset-export
6131 \end_layout
6132
6133 \begin_layout Description
6134 Origin spitz, 27 Dec 2019
6135 \end_layout
6136
6137 \begin_layout Subsection*
6138 buffer-save-as-default
6139 \end_layout
6140
6141 \begin_layout Description
6142 Action Save the current document settings as default.
6143 \end_layout
6144
6145 \begin_layout Description
6146 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
6147 \end_layout
6148
6149 \begin_layout Description
6150 Syntax buffer-save-as-default [<ARGS>]
6151 \end_layout
6152
6153 \begin_layout Description
6154 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
6155 \end_layout
6156
6157 \begin_layout Description
6158 Origin leeming, 30 Mar 2004
6159 \end_layout
6160
6161 \begin_layout Subsection*
6162 buffer-switch
6163 \end_layout
6164
6165 \begin_layout Description
6166 Action Display and switch to the given buffer.
6167 \end_layout
6168
6169 \begin_layout Description
6170 Syntax buffer-switch <BUFFER>
6171 \end_layout
6172
6173 \begin_layout Description
6174 Params <BUFFER>: path and filename of already opened (but possibly hidden) document which is to be shown.
6175 \end_layout
6176
6177 \begin_layout Subsection*
6178 buffer-toggle-compression
6179 \end_layout
6180
6181 \begin_layout Description
6182 Action Toggles compression of the current document on/off.
6183 \end_layout
6184
6185 \begin_layout Description
6186 Syntax buffer-toggle-compression
6187 \end_layout
6188
6189 \begin_layout Description
6190 Origin bpeng, 27 Apr 2006
6191 \end_layout
6192
6193 \begin_layout Subsection*
6194 buffer-toggle-read-only
6195 \end_layout
6196
6197 \begin_layout Description
6198 Action Toggle editing mode of the current document between read/write and read-only.
6199 \end_layout
6200
6201 \begin_layout Description
6202 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.
6203 \end_layout
6204
6205 \begin_layout Description
6206 Syntax buffer-toggle-read-only
6207 \end_layout
6208
6209 \begin_layout Description
6210 Origin Lgb, 27 May 1997
6211 \end_layout
6212
6213 \begin_layout Subsection*
6214 buffer-update
6215 \end_layout
6216
6217 \begin_layout Description
6218 Action Exports the current document and put the result into the temporary directory.
6219 \end_layout
6220
6221 \begin_layout Description
6222 Notion In case you are already viewing the exported document (see LFUN_BUFFER_VIEW) the output will be rewritten - updated. This is useful in case your viewer is able to detect such changes (e.g. ghostview for postscript).
6223 \end_layout
6224
6225 \begin_layout Description
6226 Syntax buffer-update [<FORMAT>]
6227 \end_layout
6228
6229 \begin_layout Description
6230 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.
6231 \end_layout
6232
6233 \begin_layout Description
6234 Origin Dekel, 5 Aug 2000
6235 \end_layout
6236
6237 \begin_layout Subsection*
6238 buffer-view
6239 \end_layout
6240
6241 \begin_layout Description
6242 Action Displays current buffer in chosen format.
6243 \end_layout
6244
6245 \begin_layout Description
6246 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.
6247 \end_layout
6248
6249 \begin_layout Description
6250 Syntax buffer-view [<FORMAT>]
6251 \end_layout
6252
6253 \begin_layout Description
6254 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.
6255 \end_layout
6256
6257 \begin_layout Subsection*
6258 buffer-view-cache
6259 \end_layout
6260
6261 \begin_layout Description
6262 Action Opens the file that was created from last preview of this buffer.
6263 \end_layout
6264
6265 \begin_layout Description
6266 Notion This LFUN is called by the "Show Output Anyway" button in the LaTeX Errors dialog. It can also be called by the user, which is useful if the document takes a long time to compile, and you just want to see the last previewed version.
6267 \end_layout
6268
6269 \begin_layout Description
6270 Syntax buffer-view-cache
6271 \end_layout
6272
6273 \begin_layout Subsection*
6274 buffer-write
6275 \end_layout
6276
6277 \begin_layout Description
6278 Action Saves the current buffer.
6279 \end_layout
6280
6281 \begin_layout Description
6282 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.
6283 \end_layout
6284
6285 \begin_layout Description
6286 Syntax buffer-write [force]
6287 \end_layout
6288
6289 \begin_layout Description
6290 Params force: write even if buffer is clean.
6291 \end_layout
6292
6293 \begin_layout Subsection*
6294 buffer-write-all
6295 \end_layout
6296
6297 \begin_layout Description
6298 Action Save all changed documents.
6299 \end_layout
6300
6301 \begin_layout Description
6302 Syntax buffer-write-all
6303 \end_layout
6304
6305 \begin_layout Description
6306 Origin rgh, gpothier 6 Aug 2007
6307 \end_layout
6308
6309 \begin_layout Subsection*
6310 buffer-write-as
6311 \end_layout
6312
6313 \begin_layout Description
6314 Action Rename and save current buffer.
6315 \end_layout
6316
6317 \begin_layout Description
6318 Syntax buffer-write-as <FILENAME>
6319 \end_layout
6320
6321 \begin_layout Description
6322 Params <FILENAME>: New name of the buffer/file. A relative path is with respect to the original location of the buffer/file.
6323 \end_layout
6324
6325 \begin_layout Subsection*
6326 buffer-write-as-template
6327 \end_layout
6328
6329 \begin_layout Description
6330 Action Rename and save current buffer in the local templates directory.
6331 \end_layout
6332
6333 \begin_layout Description
6334 Syntax buffer-write-as-template <FILENAME>
6335 \end_layout
6336
6337 \begin_layout Description
6338 Params <FILENAME>: New name of the buffer/file. A relative path                is with respect to the original location of the buffer/file.
6339 \end_layout
6340
6341 \begin_layout Subsection*
6342 buffer-zoom
6343 \end_layout
6344
6345 \begin_layout Description
6346 Action Sets the zoom of the screen fonts.
6347 \end_layout
6348
6349 \begin_layout Description
6350 Syntax buffer-zoom [<ZOOM>]
6351 \end_layout
6352
6353 \begin_layout Description
6354 Params <ZOOM>: The target zoom value in %; the default is the default zoom as saved in preferences.
6355 \end_layout
6356
6357 \begin_layout Description
6358 Origin daniel, 28 Oct 2016
6359 \end_layout
6360
6361 \begin_layout Subsection*
6362 buffer-zoom-in
6363 \end_layout
6364
6365 \begin_layout Description
6366 Action Increases the zoom of the screen fonts.
6367 \end_layout
6368
6369 \begin_layout Description
6370 Syntax buffer-zoom-in [<ZOOM>]
6371 \end_layout
6372
6373 \begin_layout Description
6374 Params <ZOOM>: The zoom value addition in % (neg. or pos.); the default is 10% of the default zoom as saved in preferences.
6375 \end_layout
6376
6377 \begin_layout Description
6378 Origin vfr, 30 Mar 2009
6379 \end_layout
6380
6381 \begin_layout Subsection*
6382 buffer-zoom-out
6383 \end_layout
6384
6385 \begin_layout Description
6386 Action Decreases the zoom of the screen fonts.
6387 \end_layout
6388
6389 \begin_layout Description
6390 Syntax buffer-zoom-out [<ZOOM>]
6391 \end_layout
6392
6393 \begin_layout Description
6394 Params <ZOOM>: The zoom value abstraction in % (neg. or pos.); the default is 10% of the default zoom as saved in preferences.
6395 \end_layout
6396
6397 \begin_layout Description
6398 Origin vfr, 30 Mar 2009
6399 \end_layout
6400
6401 \begin_layout Subsection*
6402 build-program
6403 \end_layout
6404
6405 \begin_layout Description
6406 Action Generates the code (literate programming).
6407 \end_layout
6408
6409 \begin_layout Description
6410 Notion Latex file with extension
6411 \backslash
6412 literate_extension is generated. Then LyX invokes
6413 \backslash
6414 build_command (with a default of ``make'') to generate the code and
6415 \backslash
6416 build_error_filter to process the compilation error messages.
6417 \begin_inset Newline newline
6418 \end_inset
6419
6420 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:
6421 \begin_inset Newline newline
6422 \end_inset
6423
6424
6425 \backslash
6426 build_command "my_script my_arguments"
6427 \begin_inset Newline newline
6428 \end_inset
6429
6430 The
6431 \backslash
6432 build_error_filter differs from the
6433 \backslash
6434 literate_error_filter only in that the former will identify error messages from your compiler.
6435 \end_layout
6436
6437 \begin_layout Description
6438 Syntax build-program
6439 \end_layout
6440
6441 \begin_layout Subsection*
6442 file-open
6443 \end_layout
6444
6445 \begin_layout Description
6446 Action Open LyX document.
6447 \end_layout
6448
6449 \begin_layout Description
6450 Syntax file-open [<FILE>]
6451 \end_layout
6452
6453 \begin_layout Description
6454 Params <FILE>: Filename to be opened.
6455 \end_layout
6456
6457 \begin_layout Subsection*
6458 help-open
6459 \end_layout
6460
6461 \begin_layout Description
6462 Action Open the given help file according to the language setting.
6463 \end_layout
6464
6465 \begin_layout Description
6466 Syntax help-open <FILE>[.lyx]
6467 \end_layout
6468
6469 \begin_layout Description
6470 Params <FILE>: any document from (/usr/share/)doc directory.
6471 \end_layout
6472
6473 \begin_layout Description
6474 Origin Jug, 27 Jun 1999
6475 \end_layout
6476
6477 \begin_layout Subsection*
6478 icon-size
6479 \end_layout
6480
6481 \begin_layout Description
6482 Action Sets icon size of toolbars.
6483 \end_layout
6484
6485 \begin_layout Description
6486 Syntax icon-size [<SIZE>]
6487 \end_layout
6488
6489 \begin_layout Description
6490 Params <SIZE> : the icon size in px or one of the logical settings small|normal|big|huge|giant, the default is normal (whose size in px is icon set dependent).
6491 \end_layout
6492
6493 \begin_layout Description
6494 Origin 11 July 2016
6495 \end_layout
6496
6497 \begin_layout Subsection*
6498 ifrelatives
6499 \end_layout
6500
6501 \begin_layout Description
6502 Action Helper function for master-related actions
6503 \end_layout
6504
6505 \begin_layout Description
6506 Notion In a buffer, the function will be disabled if the buffer has no master or children. It thus allows to enable actions only in documents with master/children
6507 \end_layout
6508
6509 \begin_layout Description
6510 Syntax ifrelatives <ACTION>
6511 \end_layout
6512
6513 \begin_layout Description
6514 Origin spitz, 2 January 2020
6515 \end_layout
6516
6517 \begin_layout Subsection*
6518 lyx-quit
6519 \end_layout
6520
6521 \begin_layout Description
6522 Action Terminates the current LyX instance.
6523 \end_layout
6524
6525 \begin_layout Description
6526 Notion Terminates the current LyX instance, asking whether to save modified documents, etc.
6527 \end_layout
6528
6529 \begin_layout Description
6530 Syntax lyx-quit
6531 \end_layout
6532
6533 \begin_layout Subsection*
6534 master-buffer-export
6535 \end_layout
6536
6537 \begin_layout Description
6538 Action Exports the master buffer (document) to the given format.
6539 \end_layout
6540
6541 \begin_layout Description
6542 Syntax master-buffer-export [<FORMAT>] [<DEST>]
6543 \end_layout
6544
6545 \begin_layout Description
6546 Params <FORMAT> is 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.
6547 \begin_inset Newline newline
6548 \end_inset
6549
6550 Note that "custom" is not allowed in this case.
6551 \begin_inset Newline newline
6552 \end_inset
6553
6554 If absent or "default", then the default output format of the document is used.
6555 \begin_inset Newline newline
6556 \end_inset
6557
6558 <DEST>   If present, this argument provides the export destination filename. Its containing folder will also be the destination folder, where all the needed external files will be copied.
6559 \end_layout
6560
6561 \begin_layout Description
6562 Origin rkh, 18 April 2018
6563 \end_layout
6564
6565 \begin_layout Subsection*
6566 master-buffer-forall
6567 \end_layout
6568
6569 \begin_layout Description
6570 Action Applies a command to a buffer and all it children, starting from the master.
6571 \end_layout
6572
6573 \begin_layout Description
6574 Syntax master-buffer-forall <LFUN-COMMAND>
6575 \end_layout
6576
6577 \begin_layout Description
6578 Params <LFUN-COMMAND>: The command to be applied to the buffers.
6579 \end_layout
6580
6581 \begin_layout Description
6582 Sample Close all Notes in buffers:
6583 \begin_inset Newline newline
6584 \end_inset
6585
6586                master-buffer-forall inset-forall Note inset-toggle close
6587 \begin_inset Newline newline
6588 \end_inset
6589
6590                Toggle change tracking on buffers:
6591 \begin_inset Newline newline
6592 \end_inset
6593
6594                master-buffer-forall changes-track
6595 \begin_inset Newline newline
6596 \end_inset
6597
6598                Toggle read-only for buffers:
6599 \begin_inset Newline newline
6600 \end_inset
6601
6602                master-buffer-forall buffer-toggle-read-only
6603 \begin_inset Newline newline
6604 \end_inset
6605
6606                Show statistics for individual buffers:
6607 \begin_inset Newline newline
6608 \end_inset
6609
6610                master-buffer-forall statistics
6611 \begin_inset Newline newline
6612 \end_inset
6613
6614                Activate the branch named "Solutions" in buffers:
6615 \begin_inset Newline newline
6616 \end_inset
6617
6618                master-buffer-forall branch-activate Solutions
6619 \begin_inset Newline newline
6620 \end_inset
6621
6622
6623 \end_layout
6624
6625 \begin_layout Description
6626 Origin spitz, 31 Dec 2019
6627 \end_layout
6628
6629 \begin_layout Subsection*
6630 master-buffer-update
6631 \end_layout
6632
6633 \begin_layout Description
6634 Action Update (export) the document built from the master buffer, if the current buffer is part of a master/child document.
6635 \end_layout
6636
6637 \begin_layout Description
6638 Syntax master-buffer-update [<FORMAT>]
6639 \end_layout
6640
6641 \begin_layout Description
6642 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.
6643 \end_layout
6644
6645 \begin_layout Description
6646 Origin Tommaso, 20 Sep 2007
6647 \end_layout
6648
6649 \begin_layout Subsection*
6650 master-buffer-view
6651 \end_layout
6652
6653 \begin_layout Description
6654 Action Show a preview built from the master buffer, if available. if the current buffer is part of a master/child document.
6655 \end_layout
6656
6657 \begin_layout Description
6658 Syntax master-buffer-view [<FORMAT>]
6659 \end_layout
6660
6661 \begin_layout Description
6662 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.
6663 \end_layout
6664
6665 \begin_layout Description
6666 Origin Tommaso, 20 Sep 2007
6667 \end_layout
6668
6669 \begin_layout Subsection*
6670 menu-open
6671 \end_layout
6672
6673 \begin_layout Description
6674 Action Opens the menu given by its name.
6675 \end_layout
6676
6677 \begin_layout Description
6678 Syntax menu-open <NAME>
6679 \end_layout
6680
6681 \begin_layout Description
6682 Params <NAME>: menu name. See various .inc files in lib/ui for candidates.
6683 \end_layout
6684
6685 \begin_layout Subsection*
6686 tab-group-close
6687 \end_layout
6688
6689 \begin_layout Description
6690 Action Close the current tab group.
6691 \end_layout
6692
6693 \begin_layout Description
6694 Notion This only closes the work areas, not the buffers themselves. The still opened buffers can be visualized in another tab group.
6695 \end_layout
6696
6697 \begin_layout Description
6698 Syntax tab-group-close
6699 \end_layout
6700
6701 \begin_layout Description
6702 Origin Abdel, 21 Feb 2008
6703 \end_layout
6704
6705 \begin_layout Subsection*
6706 toolbar-movable
6707 \end_layout
6708
6709 \begin_layout Description
6710 Action Toggles movability of a given toolbar between true/false.
6711 \end_layout
6712
6713 \begin_layout Description
6714 Syntax toolbar-movable <NAME>
6715 \end_layout
6716
6717 \begin_layout Description
6718 Params <NAME>: *|standard|extra|table|math|mathmacrotemplate| minibuffer|review|view/update|math_panels|vcs| view-others|update-others
6719 \end_layout
6720
6721 \begin_layout Description
6722 Origin daniel, 12 July 2016
6723 \end_layout
6724
6725 \begin_layout Subsection*
6726 toolbar-set
6727 \end_layout
6728
6729 \begin_layout Description
6730 Action Sets visibility of a given toolbar to on, off, or auto.
6731 \end_layout
6732
6733 \begin_layout Description
6734 Notion Skipping "auto" when allowauto is false.
6735 \end_layout
6736
6737 \begin_layout Description
6738 Syntax toolbar-set <NAME> [on|off|auto]
6739 \end_layout
6740
6741 \begin_layout Description
6742 Params <NAME>: standard|extra|table|math|mathmacrotemplate|
6743 \begin_inset Newline newline
6744 \end_inset
6745
6746                        minibuffer|review|view/update|math_panels|vcs|                  view-others|update-others
6747 \end_layout
6748
6749 \begin_layout Description
6750 Origin spitz, 17 Dec 2020
6751 \end_layout
6752
6753 \begin_layout Subsection*
6754 toolbar-toggle
6755 \end_layout
6756
6757 \begin_layout Description
6758 Action Toggles visibility of a given toolbar between on/off/auto.
6759 \end_layout
6760
6761 \begin_layout Description
6762 Notion Skipping "auto" when allowauto is false.
6763 \end_layout
6764
6765 \begin_layout Description
6766 Syntax toolbar-toggle <NAME> [allowauto]
6767 \end_layout
6768
6769 \begin_layout Description
6770 Params <NAME>: standard|extra|table|math|mathmacrotemplate|
6771 \begin_inset Newline newline
6772 \end_inset
6773
6774 minibuffer|review|view/update|math_panels|vcs| view-others|update-others
6775 \end_layout
6776
6777 \begin_layout Description
6778 Origin Edwin, 21 May 2007
6779 \end_layout
6780
6781 \begin_layout Subsection*
6782 ui-toggle
6783 \end_layout
6784
6785 \begin_layout Description
6786 Action Various UI visibility-toggling actions.
6787 \end_layout
6788
6789 \begin_layout Description
6790 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
6791 \end_layout
6792
6793 \begin_layout Description
6794 Params statusbar  : Toggle visibility of the statusbar.
6795 \begin_inset Newline newline
6796 \end_inset
6797
6798 menubar    : Toggle visibility of the menubar.
6799 \begin_inset Newline newline
6800 \end_inset
6801
6802 scrollbar  : Toggle visibility of the scrollbar.
6803 \begin_inset Newline newline
6804 \end_inset
6805
6806 frame      : Toggle visibility of the frames around editing window.
6807 \begin_inset Newline newline
6808 \end_inset
6809
6810 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.
6811 \end_layout
6812
6813 \begin_layout Description
6814 Origin sanda, 9 Feb 2007
6815 \end_layout
6816
6817 \begin_layout Subsection*
6818 view-close
6819 \end_layout
6820
6821 \begin_layout Description
6822 Action Close the current document work area.
6823 \end_layout
6824
6825 \begin_layout Description
6826 Notion Close the current work area. If no other work areas are showing the buffer, then close the associated buffer as well.
6827 \end_layout
6828
6829 \begin_layout Description
6830 Syntax view-close
6831 \end_layout
6832
6833 \begin_layout Description
6834 Origin Tommaso, 15 Sep 2012
6835 \end_layout
6836
6837 \begin_layout Subsection*
6838 view-split
6839 \end_layout
6840
6841 \begin_layout Description
6842 Action Creates another split view of current buffer.
6843 \end_layout
6844
6845 \begin_layout Description
6846 Notion All split views act in the same way independently.
6847 \end_layout
6848
6849 \begin_layout Description
6850 Syntax view-split <vertical|horizontal>
6851 \end_layout
6852
6853 \begin_layout Description
6854 Params horizontal : The work areas are laid out side by side.
6855 \begin_inset Newline newline
6856 \end_inset
6857
6858 vertical   : The work areas laid out vertically.
6859 \end_layout
6860
6861 \begin_layout Description
6862 Origin Abdel, 20 Feb 2008
6863 \end_layout
6864
6865 \begin_layout Subsection*
6866 window-close
6867 \end_layout
6868
6869 \begin_layout Description
6870 Action Closes the current LyX window.
6871 \end_layout
6872
6873 \begin_layout Description
6874 Syntax window-close
6875 \end_layout
6876
6877 \begin_layout Description
6878 Origin Abdel, 23 Oct 2006
6879 \end_layout
6880
6881 \begin_layout Subsection*
6882 window-new
6883 \end_layout
6884
6885 \begin_layout Description
6886 Action Creates new empty LyX window.
6887 \end_layout
6888
6889 \begin_layout Description
6890 Notion Already opened documents from the previous window can be found under View menu.
6891 \end_layout
6892
6893 \begin_layout Description
6894 Syntax window-new [<GEOMETRY>]
6895 \end_layout
6896
6897 \begin_layout Description
6898 Params <GEOMETRY>: pass the geometry of the window. This parameter is currently accepted only on Windows platform.
6899 \end_layout
6900
6901 \begin_layout Description
6902 Origin Abdel, 21 Oct 2006
6903 \end_layout
6904
6905 \begin_layout Section
6906 System Functions (Preferences, LyX Server etc.)
6907 \end_layout
6908
6909 \begin_layout Subsection*
6910 buffer-toggle-output-sync
6911 \end_layout
6912
6913 \begin_layout Description
6914 Action Toggles including of resources for forward/reverse search of the given document.
6915 \end_layout
6916
6917 \begin_layout Description
6918 Notion When toggled on, SyncTeX is invoked for PDF, while srcltx package is used for DVI. Custom LaTeX macro can be defined in preferences.
6919 \end_layout
6920
6921 \begin_layout Description
6922 Syntax buffer-toggle-output-sync
6923 \end_layout
6924
6925 \begin_layout Description
6926 Origin sanda, 25 May 2010
6927 \end_layout
6928
6929 \begin_layout Subsection*
6930 call
6931 \end_layout
6932
6933 \begin_layout Description
6934 Action Executes a command defined in a .def file.
6935 \end_layout
6936
6937 \begin_layout Description
6938 Notion The definitions are by default read from lib/commands/default.def.
6939 \begin_inset Newline newline
6940 \end_inset
6941
6942 A .def file allows to define a command with
6943 \backslash
6944 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).
6945 \backslash
6946 def_file "FileName" allows to include another .def file.
6947 \begin_inset Newline newline
6948 \end_inset
6949
6950 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.
6951 \end_layout
6952
6953 \begin_layout Description
6954 Syntax call <NAME>
6955 \end_layout
6956
6957 \begin_layout Description
6958 Params <NAME>: Name of the command that must be called.
6959 \end_layout
6960
6961 \begin_layout Description
6962 Origin broider, 2 Oct 2007
6963 \end_layout
6964
6965 \begin_layout Subsection*
6966 cancel
6967 \end_layout
6968
6969 \begin_layout Description
6970 Action Cancels sequence prepared by LFUN_META_PREFIX .
6971 \end_layout
6972
6973 \begin_layout Description
6974 Syntax cancel
6975 \end_layout
6976
6977 \begin_layout Subsection*
6978 command-alternatives
6979 \end_layout
6980
6981 \begin_layout Description
6982 Action Runs the first listed command that is enabled.
6983 \end_layout
6984
6985 \begin_layout Description
6986 Notion This can be used to bind multiple functions to a single key, and then which one is used will depend upon the context.
6987 \end_layout
6988
6989 \begin_layout Description
6990 Syntax command-alternatives <CMDS>
6991 \end_layout
6992
6993 \begin_layout Description
6994 Params <CMDS>: Sequence of commands separated by semicolons.
6995 \end_layout
6996
6997 \begin_layout Description
6998 Sample command-alternatives completion-accept;cell-forward
6999 \end_layout
7000
7001 \begin_layout Description
7002 Origin rgh, 24 September 2008
7003 \end_layout
7004
7005 \begin_layout Subsection*
7006 command-sequence
7007 \end_layout
7008
7009 \begin_layout Description
7010 Action Run more commands (LFUN and its parameters) in a sequence.
7011 \end_layout
7012
7013 \begin_layout Description
7014 Syntax command-sequence <CMDS>
7015 \end_layout
7016
7017 \begin_layout Description
7018 Params <CMDS>: Sequence of commands separated by semicolons.
7019 \end_layout
7020
7021 \begin_layout Description
7022 Sample command-sequence cut; ert-insert; self-insert
7023 \backslash
7024 ; paste; self-insert {}; inset-toggle;
7025 \end_layout
7026
7027 \begin_layout Description
7028 Origin Andre, 11 Nov 1999
7029 \end_layout
7030
7031 \begin_layout Subsection*
7032 cursor-follows-scrollbar-toggle
7033 \end_layout
7034
7035 \begin_layout Description
7036 Action Determine whether to keep cursor inside the editing window regardless of the scrollbar movement.
7037 \end_layout
7038
7039 \begin_layout Description
7040 Syntax toggle-cursor-follows-scrollbar
7041 \end_layout
7042
7043 \begin_layout Description
7044 Origin ARRae, 2 Dec 1997
7045 \end_layout
7046
7047 \begin_layout Subsection*
7048 debug-level-set
7049 \end_layout
7050
7051 \begin_layout Description
7052 Action Set debug output level.
7053 \end_layout
7054
7055 \begin_layout Description
7056 Syntax debug-level-set <LEVEL>
7057 \end_layout
7058
7059 \begin_layout Description
7060 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.
7061 \end_layout
7062
7063 \begin_layout Description
7064 Origin sanda, 28 Dec 2009
7065 \end_layout
7066
7067 \begin_layout Subsection*
7068 devel-mode-toggle
7069 \end_layout
7070
7071 \begin_layout Description
7072 Action toggle a mode where more information is given in UI
7073 \end_layout
7074
7075 \begin_layout Description
7076 Notion in so called "devel" mode, the information given in the status bar is more precise, and the help documents are open in editing mode.
7077 \end_layout
7078
7079 \begin_layout Description
7080 Syntax devel-mode-toggle
7081 \end_layout
7082
7083 \begin_layout Description
7084 Origin lasgouttes, 23 Jul 2017
7085 \end_layout
7086
7087 \begin_layout Subsection*
7088 forward-search
7089 \end_layout
7090
7091 \begin_layout Description
7092 Action Sets the cursor position in the previewed (dvi/pdf) file based on the row number in LyX window.
7093 \end_layout
7094
7095 \begin_layout Description
7096 Notion The external program used for forward search call can be specified in LyX Output preferences. See Additional manual for details of these settings.
7097 \end_layout
7098
7099 \begin_layout Description
7100 Syntax forward-search
7101 \end_layout
7102
7103 \begin_layout Description
7104 Origin sanda, 14 Apr 2010
7105 \end_layout
7106
7107 \begin_layout Subsection*
7108 lyxrc-apply
7109 \end_layout
7110
7111 \begin_layout Description
7112 Action Apply the given settings to user preferences.
7113 \end_layout
7114
7115 \begin_layout Description
7116 Syntax lyxrc-apply <SETTINGS>
7117 \end_layout
7118
7119 \begin_layout Description
7120 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.
7121 \end_layout
7122
7123 \begin_layout Subsection*
7124 message
7125 \end_layout
7126
7127 \begin_layout Description
7128 Action Shows message in statusbar (for script purposes).
7129 \end_layout
7130
7131 \begin_layout Description
7132 Syntax message <STRING>
7133 \end_layout
7134
7135 \begin_layout Description
7136 Origin Lgb, 8 Apr 2001
7137 \end_layout
7138
7139 \begin_layout Subsection*
7140 meta-prefix
7141 \end_layout
7142
7143 \begin_layout Description
7144 Action Simulate halting Meta key (Alt key on PCs).
7145 \end_layout
7146
7147 \begin_layout Description
7148 Notion Used for buffer edition not for GUI control.
7149 \end_layout
7150
7151 \begin_layout Description
7152 Syntax meta-prefix
7153 \end_layout
7154
7155 \begin_layout Subsection*
7156 preferences-save
7157 \end_layout
7158
7159 \begin_layout Description
7160 Action Save user preferences.
7161 \end_layout
7162
7163 \begin_layout Description
7164 Syntax preferences-save
7165 \end_layout
7166
7167 \begin_layout Description
7168 Origin Lgb, 27 Nov 1999
7169 \end_layout
7170
7171 \begin_layout Subsection*
7172 reconfigure
7173 \end_layout
7174
7175 \begin_layout Description
7176 Action Reconfigure the automatic settings.
7177 \end_layout
7178
7179 \begin_layout Description
7180 Syntax reconfigure
7181 \end_layout
7182
7183 \begin_layout Description
7184 Origin Asger, 14 Feb 1997
7185 \end_layout
7186
7187 \begin_layout Subsection*
7188 search-ignore
7189 \end_layout
7190
7191 \begin_layout Description
7192 Action Enables/disables searching for features in findadv
7193 \end_layout
7194
7195 \begin_layout Description
7196 Syntax search-ignore <type> <value>
7197 \end_layout
7198
7199 \begin_layout Description
7200 Params <type>: language|color|sectioning|font|series|shape|family|markup|underline|strike<value>: true|false
7201 \end_layout
7202
7203 \begin_layout Subsection*
7204 server-get-filename
7205 \end_layout
7206
7207 \begin_layout Description
7208 Action Returns path and file name of the currently edited document.
7209 \end_layout
7210
7211 \begin_layout Description
7212 Syntax server-get-filename
7213 \end_layout
7214
7215 \begin_layout Subsection*
7216 server-get-layout
7217 \end_layout
7218
7219 \begin_layout Description
7220 Action Returns the current layout (that is environment) name on the cursor position.
7221 \end_layout
7222
7223 \begin_layout Description
7224 Syntax server-get-layout
7225 \end_layout
7226
7227 \begin_layout Subsection*
7228 server-get-statistics
7229 \end_layout
7230
7231 \begin_layout Description
7232 Action Returns the statistics (number of words and characters) in the document or in the given selection.
7233 \end_layout
7234
7235 \begin_layout Description
7236 Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
7237 \end_layout
7238
7239 \begin_layout Description
7240 Syntax server-get-statistics [<TYPE>]
7241 \end_layout
7242
7243 \begin_layout Description
7244 Params <TYPE>: <words|chars|chars-space> The requested count; if not specified, the three values are returned, separated by a space.
7245 \begin_inset Newline newline
7246 \end_inset
7247
7248 words: count words.
7249 \begin_inset Newline newline
7250 \end_inset
7251
7252 chars: count characters.
7253 \begin_inset Newline newline
7254 \end_inset
7255
7256 chars-space: count characters and spaces.
7257 \end_layout
7258
7259 \begin_layout Description
7260 Origin brokenclock, Oct 10 2014
7261 \end_layout
7262
7263 \begin_layout Subsection*
7264 server-get-xy
7265 \end_layout
7266
7267 \begin_layout Description
7268 Action Returns the coordinates of cursor position in the editing area.
7269 \end_layout
7270
7271 \begin_layout Description
7272 Syntax server-get-xy
7273 \end_layout
7274
7275 \begin_layout Subsection*
7276 server-goto-file-row
7277 \end_layout
7278
7279 \begin_layout Description
7280 Action Sets the cursor position in LyX based on the row number of generated TeX file.
7281 \end_layout
7282
7283 \begin_layout Description
7284 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).
7285 \end_layout
7286
7287 \begin_layout Description
7288 Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
7289 \end_layout
7290
7291 \begin_layout Description
7292 Params <FILE>: the path and filename. Environment variables are expanded in the path. In case this LFUN does not work make sure you are giving correct path to the file.
7293 \begin_inset Newline newline
7294 \end_inset
7295
7296 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).
7297 \begin_inset Newline newline
7298 \end_inset
7299
7300 .ext: extensions will be automatically replaced by .lyx.
7301 \begin_inset Newline newline
7302 \end_inset
7303
7304 <ROW_NUMBER> The row number of the LaTeX file to which to go.
7305 \end_layout
7306
7307 \begin_layout Description
7308 Sample server-goto-file-row /home/user/example.lyx 41
7309 \begin_inset Newline newline
7310 \end_inset
7311
7312 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
7313 \end_layout
7314
7315 \begin_layout Description
7316 Origin Edmar, 23 Dec 1998
7317 \end_layout
7318
7319 \begin_layout Subsection*
7320 server-notify
7321 \end_layout
7322
7323 \begin_layout Description
7324 Action Sends notify message about the last key-sequence to client.
7325 \end_layout
7326
7327 \begin_layout Description
7328 Notion This can be used to grab last key-sequence used inside the LyX window. See also Debug extensions section in Additional features manual.
7329 \end_layout
7330
7331 \begin_layout Description
7332 Syntax server-notify
7333 \end_layout
7334
7335 \begin_layout Subsection*
7336 server-set-xy
7337 \end_layout
7338
7339 \begin_layout Description
7340 Action Sets the cursor position based on the editing area coordinates (similar to clicking on that point with left mouse button).
7341 \end_layout
7342
7343 \begin_layout Description
7344 Syntax server-set-xy <X> <Y>
7345 \end_layout
7346
7347 \begin_layout Subsection*
7348 set-color
7349 \end_layout
7350
7351 \begin_layout Description
7352 Action Set the given LyX color to the color defined by the X11 name given, and optionally a specific color for dark mode.
7353 \end_layout
7354
7355 \begin_layout Description
7356 Notion A new color entry is created if the color is unknown. Color names can be stored as a part of user settings.
7357 \end_layout
7358
7359 \begin_layout Description
7360 Syntax set-color <LYX_NAME> <X11_NAME> [<X11_DARKNAME>]
7361 \end_layout
7362
7363 \begin_layout Description
7364 Origin SLior, 11 Jun 2000
7365 \end_layout
7366
7367 \begin_layout Subsection*
7368 statistics
7369 \end_layout
7370
7371 \begin_layout Description
7372 Action Count the statistics (number of words and characters) in the document or in the given selection and display it in a dialog box.
7373 \end_layout
7374
7375 \begin_layout Description
7376 Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
7377 \end_layout
7378
7379 \begin_layout Description
7380 Syntax statistics
7381 \end_layout
7382
7383 \begin_layout Description
7384 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
7385 \end_layout
7386
7387 \begin_layout Subsection*
7388 vc-check-in
7389 \end_layout
7390
7391 \begin_layout Description
7392 Action Checks-in/commits the changes of the registered file to the repository.
7393 \end_layout
7394
7395 \begin_layout Description
7396 Notion In RCS case this also unlocks the file.
7397 \end_layout
7398
7399 \begin_layout Description
7400 Syntax vc-check-in
7401 \end_layout
7402
7403 \begin_layout Description
7404 Origin Lgb, 1 Jul 1997
7405 \end_layout
7406
7407 \begin_layout Subsection*
7408 vc-check-out
7409 \end_layout
7410
7411 \begin_layout Description
7412 Action Checks-out the document for edit (and locks it in some cases).
7413 \end_layout
7414
7415 \begin_layout Description
7416 Syntax vc-check-out
7417 \end_layout
7418
7419 \begin_layout Description
7420 Origin Lgb, 1 Jul 1997
7421 \end_layout
7422
7423 \begin_layout Subsection*
7424 vc-command
7425 \end_layout
7426
7427 \begin_layout Description
7428 Action Executes external command. This command is intended to support additional VCS commands.
7429 \end_layout
7430
7431 \begin_layout Description
7432 Syntax vc-command <FLAG> <PATH> <COMMAND>
7433 \end_layout
7434
7435 \begin_layout Description
7436 Params  <FLAG>: Flags for the command can be combined together.
7437 \begin_inset Newline newline
7438 \end_inset
7439
7440 U - dUmmy - no flags
7441 \begin_inset Newline newline
7442 \end_inset
7443
7444 D - Doc - need document loaded to proceed
7445 \begin_inset Newline newline
7446 \end_inset
7447
7448 I - dIrty - mark document dirty
7449 \begin_inset Newline newline
7450 \end_inset
7451
7452 R - Reload - ensure that the document is saved and reload it after command execution
7453 \begin_inset Newline newline
7454 \end_inset
7455
7456 M - Message - ask for input string (commit message)
7457 \begin_inset Newline newline
7458 \end_inset
7459
7460 <PATH>: path where to start. $$p will be replaced by the current document path.
7461 \begin_inset Newline newline
7462 \end_inset
7463
7464 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current document(with absolute path)/path/message.
7465 \end_layout
7466
7467 \begin_layout Description
7468 Sample vc-command DR $$p "svn up"
7469 \end_layout
7470
7471 \begin_layout Description
7472 Origin sanda, 13 Jan 2009
7473 \end_layout
7474
7475 \begin_layout Subsection*
7476 vc-compare
7477 \end_layout
7478
7479 \begin_layout Description
7480 Action Compares two revisions of the same file under version control.
7481 \end_layout
7482
7483 \begin_layout Description
7484 Syntax vc-compare [<REV1>] [<REV2>]
7485 \end_layout
7486
7487 \begin_layout Description
7488 Params Revision number either points directly to commit in history or if negative number -x it points to (last commit - x).
7489 \begin_inset Newline newline
7490 \end_inset
7491
7492 In RCS we subtract only in the last number of revision specification. Special case "0" is reserved for the last committed revision.
7493 \begin_inset Newline newline
7494 \end_inset
7495
7496 <REV1>: Older file.
7497 \begin_inset Newline newline
7498 \end_inset
7499
7500 <REV2>: Newer file. Used only if REV1 > 0.
7501 \begin_inset Newline newline
7502 \end_inset
7503
7504 If no parameter is given, interactive dialog will be shown.
7505 \end_layout
7506
7507 \begin_layout Description
7508 Sample Compare current document against last commit
7509 \begin_inset Newline newline
7510 \end_inset
7511
7512 vc-compare 0
7513 \begin_inset Newline newline
7514 \end_inset
7515
7516 Compare current document against current revision - 5 commits
7517 \begin_inset Newline newline
7518 \end_inset
7519
7520 vc-compare -5
7521 \begin_inset Newline newline
7522 \end_inset
7523
7524 Compare revisions 120 and 155
7525 \begin_inset Newline newline
7526 \end_inset
7527
7528 vc-compare 120 155
7529 \end_layout
7530
7531 \begin_layout Description
7532 Origin sanda, 12 Feb 2010
7533 \end_layout
7534
7535 \begin_layout Subsection*
7536 vc-copy
7537 \end_layout
7538
7539 \begin_layout Description
7540 Action Copies the document to another name.
7541 \end_layout
7542
7543 \begin_layout Description
7544 Notion Copying with revision history is only supported by SVN. For RCS and CVS it is simulated by adding the document under a new name. Disabled if uncommitted changes exist.
7545 \end_layout
7546
7547 \begin_layout Description
7548 Syntax vc-copy <FILENAME>
7549 \end_layout
7550
7551 \begin_layout Description
7552 Params <FILENAME>: New name of the document.
7553 \begin_inset Newline newline
7554 \end_inset
7555
7556 A file dialog is opened if no filename is given.
7557 \end_layout
7558
7559 \begin_layout Description
7560 Origin gb, 05 Feb 2013
7561 \end_layout
7562
7563 \begin_layout Subsection*
7564 vc-locking-toggle
7565 \end_layout
7566
7567 \begin_layout Description
7568 Action Toggles the locking property of the edited file.
7569 \end_layout
7570
7571 \begin_layout Description
7572 Notion This is currently implemented only for SVN.
7573 \end_layout
7574
7575 \begin_layout Description
7576 Syntax vc-locking-toggle
7577 \end_layout
7578
7579 \begin_layout Description
7580 Origin sanda, 25 Jun 2009
7581 \end_layout
7582
7583 \begin_layout Subsection*
7584 vc-register
7585 \end_layout
7586
7587 \begin_layout Description
7588 Action Register the document as an file inside version control system.
7589 \end_layout
7590
7591 \begin_layout Description
7592 Notion File is registered inside cvs, svn or rcs repository acording to the existence of cvs/svn/rcs entries in the document's directory.
7593 \begin_inset Newline newline
7594 \end_inset
7595
7596 See LyX Additional Features Manual (Version Control Chapter) for additional information.
7597 \end_layout
7598
7599 \begin_layout Description
7600 Syntax vc-register
7601 \end_layout
7602
7603 \begin_layout Description
7604 Origin Lgb, 1 Jul 1997
7605 \end_layout
7606
7607 \begin_layout Subsection*
7608 vc-rename
7609 \end_layout
7610
7611 \begin_layout Description
7612 Action Renames the document to another name.
7613 \end_layout
7614
7615 \begin_layout Description
7616 Notion Renaming with revision history is only supported by SVN. For CVS it is simulated by adding the document under a new name and deleting the old one. For RCS it is not supported. Disabled if uncommitted changes exist.
7617 \end_layout
7618
7619 \begin_layout Description
7620 Syntax vc-rename <FILENAME>
7621 \end_layout
7622
7623 \begin_layout Description
7624 Params <FILENAME>: New name of the document.
7625 \begin_inset Newline newline
7626 \end_inset
7627
7628 A file dialog is opened if no filename is given.
7629 \end_layout
7630
7631 \begin_layout Description
7632 Origin gb, 05 Feb 2013
7633 \end_layout
7634
7635 \begin_layout Subsection*
7636 vc-repo-update
7637 \end_layout
7638
7639 \begin_layout Description
7640 Action Update the local archive directory in which resides the current document with the remote repository.
7641 \end_layout
7642
7643 \begin_layout Description
7644 Syntax vc-repo-update
7645 \end_layout
7646
7647 \begin_layout Description
7648 Origin sanda, 16 Oct 2009
7649 \end_layout
7650
7651 \begin_layout Subsection*
7652 vc-revert
7653 \end_layout
7654
7655 \begin_layout Description
7656 Action Reverts the document to the last check-in/commit in VCS.
7657 \end_layout
7658
7659 \begin_layout Description
7660 Syntax vc-revert
7661 \end_layout
7662
7663 \begin_layout Description
7664 Origin Lgb, 1 Jul 1997
7665 \end_layout
7666
7667 \begin_layout Subsection*
7668 vc-undo-last
7669 \end_layout
7670
7671 \begin_layout Description
7672 Action Undo last check-in.
7673 \end_layout
7674
7675 \begin_layout Description
7676 Notion This is currently implemented only for RCS.
7677 \end_layout
7678
7679 \begin_layout Description
7680 Syntax vc-check-out
7681 \end_layout
7682
7683 \begin_layout Description
7684 Origin Lgb, 1 Jul 1997
7685 \end_layout
7686
7687 \begin_layout Section
7688 Hidden Functions (not listed for configuration)
7689 \end_layout
7690
7691 \begin_layout Subsection*
7692 command-prefix
7693 \end_layout
7694
7695 \begin_layout Description
7696 Action Return the current key sequence and available options as a string.
7697 \end_layout
7698
7699 \begin_layout Description
7700 Notion No options are added if no current map exists.
7701 \begin_inset Newline newline
7702 \end_inset
7703
7704 This is probably usable only with connection to lyxserver.
7705 \end_layout
7706
7707 \begin_layout Description
7708 Syntax command-prefix
7709 \end_layout
7710
7711 \begin_layout Subsection*
7712 lyx-activate
7713 \end_layout
7714
7715 \begin_layout Description
7716 Action Activates the LyX window.
7717 \end_layout
7718
7719 \begin_layout Description
7720 Notion On Linux and Mac OS, this action brings the LyX window into focus. Such behavior is not allowed by Windows OS so instead the color of the taskbar entry is changed to indicate that the window has changed in some way. This action is useful in combination with reverse search.
7721 \end_layout
7722
7723 \begin_layout Description
7724 Syntax lyx-activate
7725 \end_layout
7726
7727 \begin_layout Description
7728 Origin skostysh, 4 Aug 2016
7729 \end_layout
7730
7731 \begin_layout Subsection*
7732 self-insert
7733 \end_layout
7734
7735 \begin_layout Description
7736 Action Inserts the given string (accordingly to the correct keymap).
7737 \end_layout
7738
7739 \begin_layout Description
7740 Notion Automatically replace the currently selected text. Depends on lyxrc settings "auto_region_delete".
7741 \end_layout
7742
7743 \begin_layout Description
7744 Syntax self-insert <STRING>
7745 \end_layout
7746
7747 \begin_layout Subsection*
7748 window-raise
7749 \end_layout
7750
7751 \begin_layout Description
7752 Action Raises the LyX window.
7753 \end_layout
7754
7755 \begin_layout Description
7756 Notion Brings the LyX window to the front. Such behavior is allowed on Windows only when no other application has focus. This action is used when LyX is in single instance mode.
7757 \end_layout
7758
7759 \begin_layout Description
7760 Syntax window-raise
7761 \end_layout
7762
7763 \begin_layout Description
7764 Origin forenr, 21 Apr 2020
7765 \end_layout
7766
7767 \end_body
7768 \end_document