lib/doc/LFUNs.lyx

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