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