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