lib/doc/LFUNs.lyx

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