/usr/share/doc/afterstep-data/html/Functions.html is in afterstep-data 2.2.12-6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head><meta http-equiv="content-type" content="text/html; charset=ISO-8859-1">
<title>AfterStep Function</title>
<style type="text/css">
<!--
body {
margin-top: 5px;
background-repeat: repeat;
}
.copy {
margin-top: 10px;
margin-left: 4%;
margin-right: 4%;
}
.copy a:link, .copy a:visited {
color:#0FF;
text-decoration:none
}
.copy a:active, .copy a:hover {
color:#FC3;
text-decoration:underline
}
.copy2 {
margin-top: 10px;
margin-left: 0;
margin-right: 0;
}
.copy2 a:link, .copy a:visited {
color:#0FF;
text-decoration:none
}
.copy2 a:active, .copy a:hover {
color:#FC3;
text-decoration:underline
}
p.codeBlock {
background: #444444;
padding: 1em;
margin-left: 4em;
font-family:Tahoma, Arial, Verdana, Helvetica;
font-size:14px;
}
.container {
padding: -1em;
margin-left: 0em;
margin-right: 1em;
width: 100%;
background: #ccc;
border: 1px solid #000;
font-size:13px;
}
p.dense {
text-align: justify;
margin-top: 0em;
padding: 0em;
line-height: 110%;
}
p.sect_header
{
background-color: #dddddd;
color: #000000;
text-align: right;
font-size: 11pt;
}
p.refsect_header
{
text-align: left;
font-size: 14px;
line-height: 90%;
}
dl.dense {
padding: 0;
margin: 0;
font-size:14px;
}
ul.dense {
}
li.dense {
line-height: 110%;
}
dt.dense {
line-height: 110%;
text-align: bottom;
}
dd.dense {
font-size:14px;
}
-->
</style>
</head>
<body>
<A name="page_top"></A>
<A href="preface.html">Preface</A> <A href="visualselect.html">Introduction</A> <A href="index.html">Topic index</A> <A href="Glossary.html">Glossary</A><p>
<h1>AfterStep Function</h1><font size=4>built in AfterStep functions</font><hr>
<A NAME="related"><UL>
</A>
<A href="AfterStep.html">AfterStep</A>
<A href="AutoExec.html">AutoExec</A>
<A href="Base.html">Base Configuration</A>
<A href="Functions.html#options.Function">Function</A>
</UL>
<UL><LI><A NAME="options"></A><h3>CONFIGURATION OPTIONS :</h3>
<DL>
<A NAME="options.Background">
</A><DT class="dense"><B><A href="Functions.html#options.Background">Background</A> <I>"name" filename</I></B></DT>
<DD class="dense">
<P class="dense">Change <A href="Functions.html#options.Background">Background</A> image to specified file</P>
<P class="dense">Copies image file specified by filename into user's non-configurable directory.
Depending on <A href="Functions.html#options.Background">Background</A> configuration in look file, this may not have any effect.
</P>
</DD>
<A NAME="options.BackgroundForeign">
</A><DT class="dense"><B><A href="Functions.html#options.BackgroundForeign">BackgroundForeign</A> <I>"name" filename</I></B></DT>
<DD class="dense">
<P class="dense">Change <A href="Functions.html#options.Background">Background</A> image to specified file</P>
<P class="dense">Works same as <A href="Functions.html#options.Background">Background</A> but generates minipixmap from the image automagically.
Also tries to determine <A href="asimagexml.html#if">if</A> <A href="asimagexml.html#background">background</A> should be fullscreen and crops/scales it to the proper size.
</P>
</DD>
<A NAME="options.Beep">
</A><DT class="dense"><B>Beep</B></DT>
<DD class="dense">
<P class="dense">Make the window manager issue a beep - pretty useful eh? :)</P>
</DD>
<A NAME="options.BookmarkWindow">
</A><DT class="dense"><B><A href="Functions.html#options.BookmarkWindow">BookmarkWindow</A> <I>"name" new_bookmark</I></B></DT>
<DD class="dense">
<P class="dense">Places a bookmark on the selected window, to be used later
on to get back to that window.</P>
</DD>
<A NAME="options.Category">
</A><DT class="dense"><B><A href="Functions.html#options.Category">Category</A>"<I>category-name</I>"</B></DT>
<DD class="dense">
<P class="dense">Generate a menu from all the members belonging to specified desktop category. For example <A href="Functions.html#options.Category">Category</A> "Modules",
generate a menu of all AfterStep modules in afterstep/applications/modules.desktop</P>
</DD>
<A NAME="options.CategoryTree">
</A><DT class="dense"><B>CategoryTree</B></DT>
<DD class="dense">
<P class="dense">FIXME: add proper description here.</P>
</DD>
<A NAME="options.ChangeColorscheme">
</A><DT class="dense"><B><A href="Functions.html#options.ChangeColorscheme">ChangeColorscheme</A> <I>"name" filename</I></B></DT>
<DD class="dense">
<P class="dense">Change Color Scheme to specified file</P>
<P class="dense">Copies <A href="asimagexml.html#color">color</A> scheme configuration file specified by filename into user's non-configurable directory.</P>
</DD>
<A NAME="options.ChangeFeel">
</A><DT class="dense"><B><A href="Functions.html#options.ChangeFeel">ChangeFeel</A> <I>"name" filename</I></B></DT>
<DD class="dense">
<P class="dense">Change Feel to specified file</P>
<P class="dense">Copies feel configuration file specified by filename into user's non-configurable directory.</P>
</DD>
<A NAME="options.ChangeLook">
</A><DT class="dense"><B><A href="Functions.html#options.ChangeLook">ChangeLook</A> <I>"name" filename</I></B></DT>
<DD class="dense">
<P class="dense">Change Look to specified file</P>
<P class="dense">Copies Look configuration file specified by filename into user's non-configurable directory, to be used by AfterStep.</P>
</DD>
<A NAME="options.ChangeTheme">
</A><DT class="dense"><B><A href="Functions.html#options.ChangeTheme">ChangeTheme</A> <I>"name" file_name</I></B></DT>
<DD class="dense">
<P class="dense">Sets current theme config file. Such config file may include
settings for look, feel, menu, autoexec and any module.</P>
</DD>
<A NAME="options.ChangeThemeFile">
</A><DT class="dense"><B>ChangeThemeFile</B></DT>
<DD class="dense">
<P class="dense">Installs a theme from a provided .tar, .tar.gz, or .tar.bz2 AfterStep theme file.</P>
</DD>
<A NAME="options.ChangeWindowDown">
</A><DT class="dense"><B><A href="Functions.html#options.ChangeWindowDown">ChangeWindowDown</A> [<I>"name" window_name</I>]</B></DT>
<DD class="dense">
<P class="dense">Causes the pointer to move to the previous window in the list of windows for
which <I>CirculateSkip</I> has not not been specified.</P>
<P class="dense">The mouse will jump (going backwards) to the first window whose name (or
icon name or class) matches <I>window_name</I>. The <I>"name"</I> entry
then becomes required, but serves no purpose <A href="asimagexml.html#if">if</A> the function is not called
from a menu or popup.</P>
</DD>
<A NAME="options.ChangeWindowUp">
</A><DT class="dense"><B><A href="Functions.html#options.ChangeWindowUp">ChangeWindowUp</A> [<I>"name" window_name</I>]</B></DT>
<DD class="dense">
<P class="dense">Causes the pointer to move to the previous window in the list of windows
for which <I>CirculateSkip</I> has not not been specified.</P>
<P class="dense">The mouse will jump to the first window whose name (or icon name or class)
matches <I>window_name</I>. The <I>"name"</I> entry then becomes required,
but serves no purpose <A href="asimagexml.html#if">if</A> the function is not called from a menu or popup.</P>
</DD>
<A NAME="options.Close">
</A><DT class="dense"><B><A href="Functions.html#options.Close">Close</A> [<I>"name"</I>]</B></DT>
<DD class="dense">
<P class="dense">First sends the WM_DELETE message, <A href="asimagexml.html#if">if</A> this is not understood, then the
<I>XKillClient(3)</I> is sent to the window.</P>
</DD>
<A NAME="options.CursorMove">
</A><DT class="dense"><B><A href="Functions.html#options.CursorMove">CursorMove</A> <I>horizontal vertical</I></B></DT>
<DD class="dense">
<P class="dense">Moves the mouse pointer by <I>horizontal</I> views in the x-direction, and
<I>vertical</I> views in the y-direction. Either or both entries may be
negative. Both <I>horizontal</I> and <I>vertical</I> values are expressed in
percent of pages, so 100 would be one full view.</P>
<P class="dense">The <A href="Functions.html#options.CursorMove">CursorMove</A> function should not be called from pop-up menus.</P>
</DD>
<A NAME="options.Delete">
</A><DT class="dense"><B><A href="Functions.html#options.Delete">Delete</A> [<I>"name"</I>]</B></DT>
<DD class="dense">
<P class="dense">Sends a WM_DELETE message to a window asking that it remove itself,
frequently causing the application to exit.</P>
</DD>
<A NAME="options.Desk">
</A><DT class="dense"><B><A href="Functions.html#options.Desk">Desk</A> <I>arg1</I> [<I>arg2</I>]</B></DT>
<DD class="dense">
<P class="dense">Changes current desk to another desk as surmised from the arguments
supplied. If only <I>arg1</I> is specified and is non-zero, then the
current desk will become "desk + arg1" and <I>arg2</I> is ignored.
If <I>arg1</I> is zero, then <I>arg2</I> must be specified or no desk
change will occur; and <I>arg2</I> will specify the desk to switch to.
<A href="Functions.html#options.Desk">Desk</A> numbers are determined dynamically and must be between 2147483647
and -2147483648; meaning they can also be negative.</P>
</DD>
<A NAME="options.DesktopEntry">
</A><DT class="dense"><B>DesktopEntry</B></DT>
<DD class="dense">
<P class="dense">FIXME: add proper description here.</P>
</DD>
<A NAME="options.Destroy">
</A><DT class="dense"><B><A href="Functions.html#options.Destroy">Destroy</A> [<I>"name"</I>]</B></DT>
<DD class="dense">
<P class="dense">Sends the <I>XKillClient(3)</I> to a window. Guaranteed to get rid of the
window.</P>
</DD>
<A NAME="options.EndFunction">
</A><DT class="dense"><B>EndFunction</B></DT>
<DD class="dense">
<P class="dense">Terminates a Complex <A href="Functions.html#options.Function">Function</A> definition.</P>
</DD>
<A NAME="options.EndPopup">
</A><DT class="dense"><B>EndPopup</B></DT>
<DD class="dense">
<P class="dense">Terminates a <A href="Feel.html#options.Popup">Popup</A> definition.</P>
</DD>
<A NAME="options.Exec">
</A><DT class="dense"><B><A href="Functions.html#options.Exec">Exec</A> <I>"name"</I> <I>command</I> [<B>-options</B>]</B></DT>
<DD class="dense">
<P class="dense">Specifies a sub process to initiate. The <I>"name"</I> is required for
ease of parsing. The <I>command</I> is the command or application to be
invoked along with any desired <B>-options</B>.</P>
</DD>
<A NAME="options.ExecBrowser">
</A><DT class="dense"><B><A href="Functions.html#options.ExecBrowser">ExecBrowser</A> <I>"name" URL</I> </B></DT>
<DD class="dense">
<P class="dense">Open URL in web browser.</P>
</DD>
<A NAME="options.ExecEditor">
</A><DT class="dense"><B><A href="Functions.html#options.ExecEditor">ExecEditor</A> <I>"name" filename</I> </B></DT>
<DD class="dense">
<P class="dense">Open file in <A href="asimagexml.html#text">text</A> editor.</P>
</DD>
<A NAME="options.ExecInTerm">
</A><DT class="dense"><B><A href="Functions.html#options.ExecInTerm">ExecInTerm</A> <I>"name"</I> <I>command</I> [<B>-options</B>]</B></DT>
<DD class="dense">
<P class="dense">Specifies a sub process to initiate. It is similar to <A href="Functions.html#options.Exec">Exec</A> , though targeted at programs that need
a terminal to run. The following terminal emulators are tried in order: aterm, rxvt, eterm, xterm.</P>
</DD>
<A NAME="options.Focus">
</A><DT class="dense"><B>Focus</B></DT>
<DD class="dense">
<P class="dense">Moves the view or window as needed to make the selected window visible.
Sets the keyboard focus to the selected window. Raises the window <A href="asimagexml.html#if">if</A>
needed to make it visible. Warps the pointer into the selected window in
focus-follows-mouse mode. Does not de-iconify. This function is
primarily handy when used with a module such as the WinList.</P>
</DD>
<A NAME="options.Folder">
</A><DT class="dense"><B><A href="Functions.html#options.Folder">Folder</A> "<I>folder-name</I>"</B></DT>
<DD class="dense">
<P class="dense">Defines a slide-out folder inside the current folder. The following
button definitions will be placed inside of the subfolder, until a
<I>*Wharf ~Folder</I> line is encountered. See the <I>EXAMPLES</I>
section below for an example. Folders may be nested.</P>
<P class="dense">This is a Wharf specific <A href="Functions.html#options.Function">Function</A>.</P>
</DD>
<A NAME="options.Fullscreen">
</A><DT class="dense"><B>Fullscreen</B></DT>
<DD class="dense">
<P class="dense">Toggle window <A href="Functions.html#options.Fullscreen">Fullscreen</A> state. Will disregard any AvoidCover windows and will try to make window
as big as the screen unless it's hints <A href="asimagexml.html#set">set</A> certain limitation on size. <A href="MyFrame.html#overview">Window</A> in <A href="Functions.html#options.Fullscreen">Fullscreen</A> mode cannot be Maximized.</P>
</DD>
<A NAME="options.Function">
</A><DT class="dense"><B><A href="Functions.html#options.Function">Function</A> <I>"function_name"</I></B></DT>
<DD class="dense">
<P class="dense">There are also two situations where this might occur as well; as a function
definition stanza, or in calling a previously defined function decleration.</P>
<PRE>
<A href="Functions.html#options.Function">Function</A> <I>"function_name"</I>
built-in_file <B>"action"</B> [<I>argument</I>]
<A href="Functions.html#options.EndFunction">EndFunction</A>
</PRE>
<P class="dense">Specifies the definition of a complex function <I>"function_name"</I>,
which can later be bound to a mouse button or key using
<I>"function_name"</I> to <A href="asimagexml.html#recall">recall</A> this declaration. <I>built-in_command</I>
specifies which command will be performed, taking its syntax from this
list of Built-In Commands/Functions. <I>"action"</I> specifies the action
to take followed by any additional <I>arguments</I> needed by the
<I>built-in_command</I>. Menus can be specified by using the <I>Popup</I>
command, as long as the menu was defined earlier in the configuration file.</P>
<P class="dense">The trigger <I>actions</I> which are recognized are Immediate (can be
shortened to "I"), Motion, Click, DoubleClick and TripleClick. Immediate
actions are executed as soon as the function is activated, even <A href="asimagexml.html#if">if</A> a window
has not been selected. If there are actions other than immediate ones,
<B>afterstep</B> will wait to see <A href="asimagexml.html#if">if</A> the user is clicking, double-clicking,
triple-clicking or dragging the mouse; then will execute only the built-ins
from the function definition whose trigger action matches the action
performed by the user. The clicking, double-clicking and triple-clicking
concepts do not carry through to using keyboard shortcuts.</P>
<P class="dense">Two special functions exist: InitFunction and RestartFunction. The
InitFunction will be called when <B>afterstep</B> is started for the first
time in any X session, and can be used to start modules and begin programs.
The RestartFunction will be called when <B>afterstep</B> is restarted. It can
be used to re-start modules but probably should not be used to start
programs. These two functions are defined in the <I>autoexec</I> file.</P>
<P class="dense">When calling a previously defined <A href="Functions.html#options.Function">Function</A> or a <A href="Functions.html#options.Function">Function</A> from a key-stroke
combination, <A href="Functions.html#options.Function">Function</A> is simply used as a built-in command using the
previously defined <I>"action"</I> from the same <I>function_name</I>.</P>
<PRE>
<A href="Functions.html#options.Function">Function</A> <I>built-in_command</I> <I>"action"</I> <I>function_name</I>
</PRE>
<P class="dense">Refer to the <I>feel.name</I> files and below in EXAMPLES for examples.</P>
</DD>
<A NAME="options.GetHelp">
</A><DT class="dense"><B>GetHelp</B></DT>
<DD class="dense">
<P class="dense">Runs afterstepdoc script, that attempts to guess which web browser is available on the system, and then launches it to display HTML documentation for AfterStep.</P>
</DD>
<A NAME="options.GoToBookmark">
</A><DT class="dense"><B><A href="Functions.html#options.GoToBookmark">GoToBookmark</A> <I>["name" window_bookmark ]</I></B></DT>
<DD class="dense">
<P class="dense">Focuses window specified by previously placed window_bookmark.</P>
</DD>
<A NAME="options.GotoDeskViewport">
</A><DT class="dense"><B><A href="Functions.html#options.GotoDeskViewport">GotoDeskViewport</A> <I><A href="Functions.html#options.Desk">Desk</A>+Vx+Vy</I></B></DT>
<DD class="dense">
<P class="dense">Changes both current desk and viewport.</P>
</DD>
<A NAME="options.GotoPage">
</A><DT class="dense"><B><A href="Functions.html#options.GotoPage">GotoPage</A> <I>x y</I></B></DT>
<DD class="dense">
<P class="dense">Moves the desktop view to page <I>x y</I>. The upper left page is (0,0),
the upper right is (N,0), where N is one less than the current number of
horizontal pages specified in the <I>DeskTopSize</I> command detailed in the
<I>Pager(1)</I> man page. The lower left page is (0,M), and the lower right
page is (N,M), where M is the desktop's vertical size as specified in the
<I>DeskTopSize</I> command.</P>
<P class="dense">The <A href="Functions.html#options.GotoPage">GotoPage</A> function should not be used in a pop-up menu.</P>
</DD>
<A NAME="options.Iconify">
</A><DT class="dense"><B><A href="Functions.html#options.Iconify">Iconify</A> [<I>"name"</I>] [<I>value</I>]</B></DT>
<DD class="dense">
<P class="dense">Iconifies a window <A href="asimagexml.html#if">if</A> it is not already iconified, or de-iconifies it <A href="asimagexml.html#if">if</A>
it is already iconified. If the optional argument <I>value</I> is positive,
then only iconification will be allowed, and de-iconification will be
inhibited. If the optional argument is negative, only de-iconification will
be allowed.</P>
</DD>
<A NAME="options.InstallBackground">
</A><DT class="dense"><B><A href="Functions.html#options.InstallBackground">InstallBackground</A> <I>"name" filename</I></B></DT>
<DD class="dense">
<P class="dense">Copies specified file to ~/.afterstep/backgrounds/ directory, so that it will show up in the menu, to be used for Root <A href="asimagexml.html#background">background</A>.</P>
</DD>
<A NAME="options.InstallColorscheme">
</A><DT class="dense"><B><A href="Functions.html#options.InstallColorscheme">InstallColorscheme</A> <I>"name" filename</I></B></DT>
<DD class="dense">
<P class="dense">Copies specified file to ~/.afterstep/colorschemes/ directory, so that it will show up in the menu, to be used as <A href="asimagexml.html#color">color</A> scheme.</P>
</DD>
<A NAME="options.InstallFeel">
</A><DT class="dense"><B><A href="Functions.html#options.InstallFeel">InstallFeel</A> <I>"name" filename</I></B></DT>
<DD class="dense">
<P class="dense">Copies specified file to ~/.afterstep/feels/ directory, so that it will show up in the menu.</P>
</DD>
<A NAME="options.InstallFont">
</A><DT class="dense"><B><A href="Functions.html#options.InstallFont">InstallFont</A> <I>"name" filename</I></B></DT>
<DD class="dense">
<P class="dense">Copies specified TTF file to ~/.afterstep/desktop/fonts/ directory, so that it could be used in look configuration.</P>
</DD>
<A NAME="options.InstallIcon">
</A><DT class="dense"><B><A href="Functions.html#options.InstallIcon">InstallIcon</A> <I>"name" filename</I></B></DT>
<DD class="dense">
<P class="dense">Copies specified image file to ~/.afterstep/desktop/icons/ directory, so that it could be used in look and database configuration.</P>
</DD>
<A NAME="options.InstallLook">
</A><DT class="dense"><B><A href="Functions.html#options.InstallLook">InstallLook</A> <I>"name" filename</I></B></DT>
<DD class="dense">
<P class="dense">Copies specified look file to ~/.afterstep/looks/ directory, so that it could be selected from the menu.</P>
</DD>
<A NAME="options.InstallThemeFile">
</A><DT class="dense"><B><A href="Functions.html#options.InstallThemeFile">InstallThemeFile</A> <I>"name" filename</I></B></DT>
<DD class="dense">
<P class="dense">Copies specified theme file to ~/.afterstep/themes/ directory, so that it could be selected from the menu.</P>
</DD>
<A NAME="options.InstallTile">
</A><DT class="dense"><B><A href="Functions.html#options.InstallTile">InstallTile</A> <I>"name" filename</I></B></DT>
<DD class="dense">
<P class="dense">Copies specified image file to ~/.afterstep/desktop/tiles/ directory, so that it could be used in look and database configuration.</P>
</DD>
<A NAME="options.KIPCsendMessageAll">
</A><DT class="dense"><B>KIPCsendMessageAll</B></DT>
<DD class="dense">
<P class="dense">Sends a signal to all <A href="SupportedHints.html#options.KDE">KDE</A> applications, refreshing their visual properties.</P>
</DD>
<A NAME="options.KillAllModulesByName">
</A><DT class="dense"><B>KillAllModulesByName</B></DT>
<DD class="dense">
<P class="dense">Kills AfterStep modules with a provided matching name.</P>
</DD>
<A NAME="options.KillModuleByName">
</A><DT class="dense"><B><A href="Functions.html#options.KillModuleByName">KillModuleByName</A> <I>"name" modulename</I></B></DT>
<DD class="dense">
<P class="dense">Kill module with specified name.</P>
</DD>
<A NAME="options.LargeMiniPixmap">
</A><DT class="dense"><B><A href="Functions.html#options.LargeMiniPixmap">LargeMiniPixmap</A> <I>pixmap</I></B></DT>
<DD class="dense">
<P class="dense">Specifies a given pixmap to display to the left of the menu item which invokes this menu, or in the title of this menu. Used in menu entries instead of <A href="Functions.html#options.MiniPixmap">MiniPixmap</A> when it is not desired to <A href="asimagexml.html#scale">scale</A>-down a pixmap image. Pixmap images are full-size. Opposite is <A href="Functions.html#options.SmallMiniPixmap">SmallMiniPixmap</A>.</P>
<P class="dense">See Also: <A href="Functions.html#options.MiniPixmap">MiniPixmap</A>, <A href="Functions.html#options.SmallMiniPixmap">SmallMiniPixmap</A>, <A href="Look.html#options.MenuMiniPixmaps">MenuMiniPixmaps</A>.</P>
</DD>
<A NAME="options.Lower">
</A><DT class="dense"><B><A href="Functions.html#options.Lower">Lower</A> [<I>"name"</I>]</B></DT>
<DD class="dense">
<P class="dense">Allows the user to lower a window.</P>
</DD>
<A NAME="options.MaxSwallow">
</A><DT class="dense"><B><A href="Functions.html#options.MaxSwallow">MaxSwallow</A> "<I>window-name</I>" <I>command</I></B></DT>
<DD class="dense">
<P class="dense">Like <I>Swallow</I>, except the button will be resized to fit the
application.</P>
<P class="dense">This is a Wharf specific <A href="Functions.html#options.Function">Function</A>.</P>
</DD>
<A NAME="options.MaxSwallowModule">
</A><DT class="dense"><B><A href="Functions.html#options.MaxSwallowModule">MaxSwallowModule</A> "<I>window-name</I>" <I>command</I></B></DT>
<DD class="dense">
<P class="dense">Like <I>MaxSwallow</I>, except the <I>command</I> is an AfterStep module.</P>
<P class="dense">This is a Wharf specific <A href="Functions.html#options.Function">Function</A>.</P>
</DD>
<A NAME="options.Maximize">
</A><DT class="dense"><B><A href="Functions.html#options.Maximize">Maximize</A> [<I>"name"</I>] [<I>horizontal vertical</I>]</B></DT>
<DD class="dense">
<P class="dense">Causes the window to alternately switch from a full-screen size to its
normal size. Specifying the optional arguments of <I>horizontal</I> and
<I>vertical</I>, control can be attained as to the percentage of the full
screen that the new size of the window becomes. If <I>horizontal</I> > 0,
then the horizontal dimension of the window will be <A href="asimagexml.html#set">set</A> to
horizontal*screen_width/100. The vertical resizing is similar. Values
larger than 100 can be used with caution. The defaults for <I>horizontal</I>
and <I>vertical</I> are 100s (ie, fullscreen).</P>
</DD>
<A NAME="options.MiniPixmap">
</A><DT class="dense"><B><A href="Functions.html#options.MiniPixmap">MiniPixmap</A> <I>pixmap</I></B></DT>
<DD class="dense">
<P class="dense">Specifies a given pixmap to display to the left of the menu item which invokes this menu, or in the title of this menu. Default pixmap size is 24x24 pixels; this size can be adjusted in Look via MiniPixmapSize.</P>
<P class="dense">See Also: <A href="Look.html#options.MinipixmapSize">MinipixmapSize</A>, <A href="Functions.html#options.LargeMiniPixmap">LargeMiniPixmap</A>, <A href="Functions.html#options.SmallMiniPixmap">SmallMiniPixmap</A>, <A href="Look.html#options.MenuMiniPixmaps">MenuMiniPixmaps</A>.</P>
</DD>
<A NAME="options.Module">
</A><DT class="dense"><B><A href="Functions.html#options.Module">Module</A> <I>ModuleName</I> [<I>arguments</I>]</B></DT>
<DD class="dense">
<P class="dense">Specifies that <I>ModuleName</I> should be spawned.</P>
<P class="dense">Currently, many modules are included with <B>afterstep</B>. <I>Wharf(1x)</I>
and <I>Pager(1x)</I> are two of the more popular ones. Wharf will normally
be spawned during initialization instead of in response to a mouse binding
or menu action. Modules can be short lived transient programs, or, like
Wharf, can be intended to remain for the duration of the X session.
Modules will be terminated by <B>afterstep</B> prior to restarts and quits,
<A href="asimagexml.html#if">if</A> possible.</P>
</DD>
<A NAME="options.Move">
</A><DT class="dense"><B><A href="Functions.html#options.Move">Move</A> [<I>"name"</I>]</B></DT>
<DD class="dense">
<P class="dense">Allows the user to move a window or iconified app.</P>
</DD>
<A NAME="options.Nop">
</A><DT class="dense"><B><A href="Functions.html#options.Nop">Nop</A> ""</B></DT>
<DD class="dense">
<P class="dense">Inserts a horizontal line (<HR> type html line) in a menu entry list.</P>
</DD>
<DT class="dense"><B><A href="Functions.html#options.Nop">Nop</A> "name"</B></DT>
<DD class="dense">
<P class="dense">Inserts a <I>name</I> in the menu, stippled (disabled and grayed-out).</P>
</DD>
<A NAME="options.PasteSelection">
</A><DT class="dense"><B>PasteSelection</B></DT>
<DD class="dense">
<P class="dense">This function allows for substitute of X clipboard copy-pasting <A href="asimagexml.html#if">if</A> application is missing it.</P>
</DD>
<A NAME="options.PinMenu">
</A><DT class="dense"><B><A href="Functions.html#options.PinMenu">PinMenu</A> <I>["name"]</I></B></DT>
<DD class="dense">
<P class="dense">Pins menu on desktop.</P>
</DD>
<A NAME="options.PopUp">
</A><DT class="dense"><B><A href="Functions.html#options.PopUp">PopUp</A> <I>"popup_name"</I></B></DT>
<DD class="dense">
<P class="dense">There are two situations where this might occur; as a popup menu stanza
definition, or in calling a previously defined menu declaration.</P>
<PRE>
<A href="Feel.html#options.Popup">Popup</A> <I>"popup_name"</I>
built-in_command <I>"name"</I> [<I>argument</I>]
<A href="Functions.html#options.EndPopup">EndPopup</A>
</PRE>
<P class="dense">Specfies the definition of a complex menu popup <I>"popup_name"</I>, which
can be bound to a mouse button or key using <I>"popup_name"</I> to <A href="asimagexml.html#recall">recall</A>
this declaration. <I>built-in_command</I> specifies which command will be
performed, utilizing it's syntax from this list of Built-In
Commands/Functions. <I>"name"</I> specifies the name which will appear
within the menu for the given item, and additionally any <I>arguments</I>
needed by the <I>built-in_command</I>. The <A href="Feel.html#options.Popup">Popup</A> definition ends with the
keyword <A href="Functions.html#options.EndPopup">EndPopup</A>. Sub-menus can be created by calling the <A href="Feel.html#options.Popup">Popup</A> built-in
within another <A href="Feel.html#options.Popup">Popup</A> declaration, as long as that sub-menu was defined
earlier in the configuration file.</P>
<P class="dense">Shortcut keys may be specified in the menu definition by preceding a
character with an ampersand. The ampersand will not be displayed, but the
character after it will be displayed at the right side of the same entry.
and <A href="asimagexml.html#if">if</A> the user presses the corresponding key, then that item will be
activated as <A href="asimagexml.html#if">if</A> it had been clicked upon.
Only alphanumeric characters
may be used as shortcut keys. The shift state of the keyboard is ignored
when testing shortcut characters.</P>
Shortcut keys are not operative unless MENU_HOTKEYS was defined when
building AfterStep. If WINDOWLIST_HOTKETS was also defined, then hot
keys are automatically added to the <A href="Functions.html#options.WindowList">WindowList</A> when it is displayed.
<P class="dense">When calling a previously defined menu or a menu from a key-stroke
combination, <A href="Feel.html#options.Popup">Popup</A> is simply used as a built-in command with the
<I>"name"</I> referring to the previously defined <A href="Feel.html#options.Popup">Popup</A> definitions name.</P>
<P class="dense">Popups can be bound to keys through the use of the key modifier. Popups
can be operated without using the mouse by binding to keys, and operating
via the up arrow, down arrow, and enter keys. Refer to the <I>feel.name</I>
files and below in EXAMPLES for examples.</P>
</DD>
<A NAME="options.PutOnBack">
</A><DT class="dense"><B>PutOnBack</B></DT>
<DD class="dense">
<P class="dense">Moves the target window to the bottom of its layer, or down one layer <A href="asimagexml.html#if">if</A>
it is already at the bottom.</P>
</DD>
<A NAME="options.PutOnTop">
</A><DT class="dense"><B>PutOnTop</B></DT>
<DD class="dense">
<P class="dense">Moves the target window to the top of its layer, or up one layer <A href="asimagexml.html#if">if</A> it
is already at the top.</P>
</DD>
<A NAME="options.QuickRestart">
</A><DT class="dense"><B><A href="Functions.html#options.QuickRestart">QuickRestart</A> <I> look|feel|look+feel</I></B></DT>
<DD class="dense">
<P class="dense">Causes AfterStep to reload specified config.</P>
</DD>
<A NAME="options.Quit">
</A><DT class="dense"><B><A href="Functions.html#options.Quit">Quit</A> [<I>"name"</I>]</B></DT>
<DD class="dense">
<P class="dense">Exits <B>afterstep</B>, generally causing X to exit too.</P>
</DD>
<A NAME="options.Raise">
</A><DT class="dense"><B><A href="Functions.html#options.Raise">Raise</A> [<I>"name"</I>]</B></DT>
<DD class="dense">
<P class="dense">Allows the user to raise a window.</P>
</DD>
<A NAME="options.RaiseLower">
</A><DT class="dense"><B><A href="Functions.html#options.RaiseLower">RaiseLower</A> [<I>"name"</I>]</B></DT>
<DD class="dense">
<P class="dense">Alternately raises and lowers a window; i.e. <A href="asimagexml.html#if">if</A> it's raised, the window
will lower, and vice versa.</P>
</DD>
<A NAME="options.Refresh">
</A><DT class="dense"><B><A href="Functions.html#options.Refresh">Refresh</A> [<I>"name"</I>]</B></DT>
<DD class="dense">
<P class="dense">Causes all windows on the screen to re-draw themselves.</P>
</DD>
<A NAME="options.Resize">
</A><DT class="dense"><B><A href="Functions.html#options.Resize">Resize</A> [<I>"name"</I>]</B></DT>
<DD class="dense">
<P class="dense">Allows the user to resize a window.</P>
</DD>
<A NAME="options.Restart">
</A><DT class="dense"><B><A href="Functions.html#options.Restart">Restart</A> <I>"name"</I> <I>WindowManagerName</I></B></DT>
<DD class="dense">
<P class="dense">Restarts <I>X(1)</I> with the given <I>WindowManagerName</I>. If
<I>WindowManagerName</I> is<B>afterstep</B>, then this forces
<B>afterstep</B> to reread all of its configuration files and reinitiate
the session. If <I>WindowManagerName</I> is not in the default search
path, then the full path name should be given.</P>
</DD>
<A NAME="options.RestartModuleByName">
</A><DT class="dense"><B>RestartModuleByName</B></DT>
<DD class="dense">
<P class="dense">Restarts AfterStep modules with a provided matching name.</P>
</DD>
<A NAME="options.RestartModuleList">
</A><DT class="dense"><B>RestartModuleList</B></DT>
<DD class="dense">
<P class="dense">Restarts all AfterStep modules.</P>
</DD>
<A NAME="options.SET_FLAGS">
</A><DT class="dense"><B>SET_FLAGS</B></DT>
<DD class="dense">
<P class="dense">Do not use. Reserved for use by AfterStep modules to <A href="asimagexml.html#set">set</A> communication flags - identifying which messages module wishes to receive.</P>
</DD>
<A NAME="options.SET_MASK">
</A><DT class="dense"><B>SET_MASK</B></DT>
<DD class="dense">
<P class="dense">Do not use. Reserved for use by AfterStep modules.</P>
</DD>
<A NAME="options.SET_NAME">
</A><DT class="dense"><B>SET_NAME</B></DT>
<DD class="dense">
<P class="dense">Do not use. Reserved for use by AfterStep modules to identify themselves to AfterStep.</P>
</DD>
<A NAME="options.SaveWorkspace">
</A><DT class="dense"><B><A href="Functions.html#options.SaveWorkspace">SaveWorkspace</A> <I>"name" file_name</I></B></DT>
<DD class="dense">
<P class="dense">Write list of presently running applications with its position
and desktop number into specified file. You can run this file
at a later time as a shell script to restore state of the
desktop. Note this does not work for many applications that
does not provide needed <A href="SupportedHints.html#options.ICCCM">ICCCM</A> properties on its windows.</P>
</DD>
<A NAME="options.Scroll">
</A><DT class="dense"><B><A href="Functions.html#options.Scroll">Scroll</A> <I>horizontal vertical</I></B></DT>
<DD class="dense">
<P class="dense">Scrolls the desktop's view by <I>horizontal</I> pages in the x-direction,
and <I>vertical</I> pages in the y-direction. Either or both entries may be
negative. Both <I>horizontal</I> and <I>vertical</I> values are expressed
in percent of pages, so 100 would be one full page. Normally, scrolling
stops at the edge of the desktop. If the <I>horizontal</I> and
<I>vertical</I> values are multiplied by 1000, then scrolling will wrap
around at the edge of the desktop.</P>
<P class="dense">The scroll function should not be called from pop-up menus.</P>
</DD>
<A NAME="options.Send_WindowList">
</A><DT class="dense"><B>Send_WindowList</B></DT>
<DD class="dense">
<P class="dense">This <A href="Functions.html#options.Function">Function</A> is used by modules to obtain list of <A href="WharfSounds.html#options.open_folder">open</A> windows.</P>
</DD>
<A NAME="options.Set">
</A><DT class="dense"><B>Set</B></DT>
<DD class="dense">
<P class="dense">FIXME: add proper description here.</P>
</DD>
<A NAME="options.SetLayer">
</A><DT class="dense"><B><A href="Functions.html#options.SetLayer">SetLayer</A> <I>layer</I></B></DT>
<DD class="dense">
<P class="dense">Moves the target window to layer <I>layer</I>.</P>
</DD>
<A NAME="options.Shade">
</A><DT class="dense"><B><A href="Functions.html#options.Shade">Shade</A> [<I>"name"</I>]</B></DT>
<DD class="dense">
<P class="dense">Emulates the MacOS WindowShade feature. Once activated the window will
become a titlebar only.</P>
</DD>
<A NAME="options.SignalReloadGTKRCFile">
</A><DT class="dense"><B>SignalReloadGTKRCFile</B></DT>
<DD class="dense">
<P class="dense">Forces all GTK apps to reload the gtkrc files.</P>
</DD>
<A NAME="options.Size">
</A><DT class="dense"><B><A href="Functions.html#options.Size">Size</A> <I>width</I> <I>height</I></B></DT>
<DD class="dense">
<P class="dense">Sets the size of the associated button, overriding any other size
consideration.</P>
<P class="dense">The <B>Wharf</B> button size depends on several things. The order of
precedence is:</P>
<PRE>
1) <A href="Functions.html#options.Size">Size</A> definition
2) <A href="Functions.html#options.MaxSwallow">MaxSwallow</A>'d window size
3) <I>WharfPixmap</I> size
4) <A href="MyBackground.html#options.Use">Use</A> 64x64.
</PRE>
<P class="dense">This is a Wharf specific <A href="Functions.html#options.Function">Function</A>.</P>
</DD>
<A NAME="options.SmallMiniPixmap">
</A><DT class="dense"><B><A href="Functions.html#options.SmallMiniPixmap">SmallMiniPixmap</A> <I>pixmap</I></B></DT>
<DD class="dense">
<P class="dense">Specifies a given pixmap to display to the left of the menu item which invokes this menu, or in the title of this menu. Used in menu entries instead of <A href="Functions.html#options.MiniPixmap">MiniPixmap</A>; scales-down pixmap images to the smallest size. It is sized based-on the Menu font size plus eight pixels; width is calculated to keep proportionality.</P>
<P class="dense">See Also: <A href="Functions.html#options.MiniPixmap">MiniPixmap</A>, <A href="Functions.html#options.LargeMiniPixmap">LargeMiniPixmap</A>, <A href="Look.html#options.MenuMiniPixmaps">MenuMiniPixmaps</A>.</P>
</DD>
<A NAME="options.Stick">
</A><DT class="dense"><B><A href="Functions.html#options.Stick">Stick</A> [<I>"name"</I>]</B></DT>
<DD class="dense">
<P class="dense">Makes a window sticky (stays on screen when desks/views are switched) <A href="asimagexml.html#if">if</A> it
is not already sticky, or non-sticky <A href="asimagexml.html#if">if</A> it is already sticky.</P>
</DD>
<A NAME="options.StopModuleList">
</A><DT class="dense"><B>StopModuleList</B></DT>
<DD class="dense">
<P class="dense">Stops all AfterStep modules.</P>
</DD>
<A NAME="options.Swallow">
</A><DT class="dense"><B><A href="Functions.html#options.Swallow">Swallow</A> "<I>window-name</I>" <I>command</I></B></DT>
<DD class="dense">
<P class="dense">Causes <B>Wharf</B> to run <I>command</I>, capture the first window whose
name or resource is <I>window-name</I>, and display it in the associated
button. The application window will be shrunk to fit the size of the
button.</P>
<P class="dense">This is a Wharf specific <A href="Functions.html#options.Function">Function</A>.</P>
</DD>
<A NAME="options.SwallowModule">
</A><DT class="dense"><B><A href="Functions.html#options.SwallowModule">SwallowModule</A> "<I>window-name</I>" <I>command</I></B></DT>
<DD class="dense">
<P class="dense">Like <I>Swallow</I>, except the <I>command</I> is an AfterStep module.</P>
<P class="dense">This is a Wharf specific <A href="Functions.html#options.Function">Function</A>.</P>
</DD>
<A NAME="options.SwallowWindow">
</A><DT class="dense"><B><A href="Functions.html#options.SwallowWindow">SwallowWindow</A> <I>"pattern" shell_command</I></B></DT>
<DD class="dense">
<P class="dense">will cause already opened window to be swallowed, while
just <A href="Functions.html#options.Swallow">Swallow</A> will run application, <A href="asimagexml.html#if">if</A> there are no windows matching
pattern</P>
</DD>
<A NAME="options.TakeFrameShot">
</A><DT class="dense"><B><A href="Functions.html#options.TakeFrameShot">TakeFrameShot</A> <I>"name" filename</I></B></DT>
<DD class="dense">
<P class="dense">Grabs screenshot of the client window including frame decorations and <A href="asimagexml.html#save">save</A> it in specifyed files.</P>
</DD>
<A NAME="options.TakeScreenShot">
</A><DT class="dense"><B><A href="Functions.html#options.TakeScreenShot">TakeScreenShot</A> <I>"name" filename</I></B></DT>
<DD class="dense">
<P class="dense">Grabs screenshot of the entire screen and <A href="asimagexml.html#save">save</A> it in specifyed files.</P>
</DD>
<A NAME="options.TakeWindowShot">
</A><DT class="dense"><B><A href="Functions.html#options.TakeWindowShot">TakeWindowShot</A> <I>"name" filename</I></B></DT>
<DD class="dense">
<P class="dense">Grabs screenshot of the client window excluding frame decorations and <A href="asimagexml.html#save">save</A> it in specifyed files.</P>
</DD>
<A NAME="options.Test">
</A><DT class="dense"><B>Test</B></DT>
<DD class="dense">
<P class="dense">Do not use. Internal function.</P>
</DD>
<A NAME="options.Title">
</A><DT class="dense"><B><A href="Functions.html#options.Title">Title</A> <I>"name"</I></B></DT>
<DD class="dense">
<P class="dense">Insert a title line of heading <I>name</I> into a popup or menu.</P>
</DD>
<A NAME="options.ToggleLayer">
</A><DT class="dense"><B><A href="Functions.html#options.ToggleLayer">ToggleLayer</A> <I>layer1</I> <I>layer2</I></B></DT>
<DD class="dense">
<P class="dense">Specifies that <A href="asimagexml.html#if">if</A> the window is in <I>layer1</I>, it should be placed in
<I>layer2</I>. Otherwise, it is placed in <I>layer1</I>. In either case,
the window will be placed on top of other windows in the target layer.</P>
</DD>
<A NAME="options.TogglePage">
</A><DT class="dense"><B><A href="Functions.html#options.TogglePage">TogglePage</A> [<I>"name"</I>]</B></DT>
<DD class="dense">
<P class="dense">Temporarily disables <I>EdgeScroll</I>. Edge scrolling can be re-enabled by
calling this again.</P>
</DD>
<A NAME="options.Transient">
</A><DT class="dense"><B>Transient</B></DT>
<DD class="dense">
<P class="dense">Specifies that this button will not perform any action, will not be
pushable, and will not have an associated balloon.</P>
<P class="dense"></P></DD>
<A NAME="options.UNLOCK">
</A><DT class="dense"><B>UNLOCK</B></DT>
<DD class="dense">
<P class="dense">Do not use. Internal function.</P>
</DD>
<A NAME="options.Wait">
</A><DT class="dense"><B><A href="Functions.html#options.Wait">Wait</A> <I>app_name</I></B></DT>
<DD class="dense">
<P class="dense">This is intended to be used in <B>afterstep</B> functions only. It causes
execution of a function to pause until a new window named <I>app_name</I>
appears. <B>afterstep</B> remains fully functional during a wait. This is
particularly useful in the InitFunction and RestartFunction, <A href="asimagexml.html#if">if</A> you are
trying to start windows on specific desktops.</P>
</DD>
<A NAME="options.WarpBack">
</A><DT class="dense"><B><A href="Functions.html#options.WarpBack">WarpBack</A> [<I>"name" window_name</I>]</B></DT>
<DD class="dense">
<P class="dense">Same as <I>ChangeWindowDown</I>, but uniconifies any iconified windows as it
focuses on them.</P>
</DD>
<A NAME="options.WarpFore">
</A><DT class="dense"><B><A href="Functions.html#options.WarpFore">WarpFore</A> [<I>"name" window_name</I>]</B></DT>
<DD class="dense">
<P class="dense">Same as <I>ChangeWindowUp</I>, but uniconifies any iconified windows as it
focuses on them.</P>
</DD>
<A NAME="options.WindowList">
</A><DT class="dense"><B><A href="Functions.html#options.WindowList">WindowList</A> [<I>arg1 arg2</I>]</B></DT>
<DD class="dense">
<P class="dense">Specifies the internal popup menu in which the titles of each <A href="WharfSounds.html#options.open_folder">open</A>
application are displayed, should be popped up. Selecting an item from the
list will cause the current desk to switch to the application's desk, and
will raise it <A href="asimagexml.html#if">if</A> it's behind other windows. If the application is currently
iconified, then it will be de-iconified normally.</P>
<P class="dense">Generally, <A href="asimagexml.html#if">if</A> <I>arg1</I> is an even number, then the windows will be listed
using the window name (the name that shows up in the title-bar); <A href="asimagexml.html#if">if</A>
<I>arg1</I> is an odd number, then the window's icon name is used.</P>
<P class="dense">Specifically, <A href="asimagexml.html#if">if</A> <I>arg1</I> is 0, 1 or 2, then all windows on all desks
will be shown. If <I>arg1</I> is 2 or 3, then only windows on the current
desk will be shown. If <I>arg1</I> is 4 or 5, then only windows on the
desk number specified with <I>arg2</I>, will be shown. Windows which have
WindowListSkip specified in their style will not be listed in the window
list.</P>
</DD>
<A NAME="options.WindowsDesk">
</A><DT class="dense"><B><A href="Functions.html#options.WindowsDesk">WindowsDesk</A> <I>new_desk</I> [10000]</B></DT>
<DD class="dense">
<P class="dense">Moves the selected window to the desktop specified as <I>new_desk</I>.
If second argument is <A href="asimagexml.html#set">set</A> to 10000 then first is treated as relative
desktop number.</P>
</DD>
</DL></P></LI>
</UL>
<p><A href="preface.html">Preface</A> <A href="visualselect.html">Introduction</A> <A href="index.html">Topic index</A> <A href="Glossary.html">Glossary</A> <A href="#page_top">Back to Top</A>
<hr>
<p><FONT face="Verdana, Arial, Helvetica, sans-serif" size="-2">AfterStep version 2.2.12</a></FONT>
</body>
</html>
|