lib/doc/LFUNs.lyx

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