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