lib/doc/LFUNs.lyx

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