lib/doc/LFUNs.lyx

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