lib/doc/LFUNs.lyx

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