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