perllib/FVWM/Commands.pm

   1 # Autogenerated from the fvwm sources.
   2
   3 package FVWM::Commands;
   4
   5 use vars qw($VERS $TIME @LIST);
   6
   7 $VERS = '2.5.28 (from cvs)';
   8 $TIME = 1237313570;
   9
  10 @LIST = (
  11         {
  12                 name => '#',
  13                 cursor => '',
  14                 window => 0,
  15                 descr => q{Comment line (ignored)},
  16         },
  17         {
  18                 name => '*',
  19                 cursor => '',
  20                 window => 0,
  21                 descr => q{Module configuration line (no space after asterisk)},
  22         },
  23         {
  24                 name => '+',
  25                 cursor => '',
  26                 window => 0,
  27                 descr => q{Continue the last AddToFunc, AddToMenu or AddToDecor},
  28         },
  29         {
  30                 name => 'AddButtonStyle',
  31                 cursor => '',
  32                 window => 0,
  33                 descr => q{Add to a button style (see ButtonStyle)},
  34         },
  35         {
  36                 name => 'AddTitleStyle',
  37                 cursor => '',
  38                 window => 0,
  39                 descr => q{Add to a title style (see TitleStyle)},
  40         },
  41         {
  42                 name => 'AddToDecor',
  43                 cursor => '',
  44                 window => 0,
  45                 descr => q{Add a decor definition (will be obsolete)},
  46         },
  47         {
  48                 name => 'AddToFunc',
  49                 cursor => '',
  50                 window => 0,
  51                 descr => q{Add a function definition},
  52         },
  53         {
  54                 name => 'AddToMenu',
  55                 cursor => '',
  56                 window => 0,
  57                 descr => q{Add a menu definition},
  58         },
  59         {
  60                 name => 'All',
  61                 cursor => '',
  62                 window => 0,
  63                 descr => q{Operate on all windows matching the given condition},
  64         },
  65         {
  66                 name => 'AnimatedMove',
  67                 cursor => 'MOVE',
  68                 window => 1,
  69                 descr => q{Like Move, but uses animation to move windows},
  70         },
  71         {
  72                 name => 'Any',
  73                 cursor => '',
  74                 window => 0,
  75                 descr => q{Operate if there is any window matching the condition},
  76         },
  77         {
  78                 name => 'Beep',
  79                 cursor => '',
  80                 window => 0,
  81                 descr => q{Produce a bell},
  82         },
  83         {
  84                 name => 'BorderStyle',
  85                 cursor => '',
  86                 window => 0,
  87                 descr => q{Define a window border look (will be reworked)},
  88         },
  89         {
  90                 name => 'Break',
  91                 cursor => '',
  92                 window => 0,
  93                 descr => q{Stop executing the current (but not parent) function},
  94         },
  95         {
  96                 name => 'BugOpts',
  97                 cursor => '',
  98                 window => 0,
  99                 descr => q{Set some application bug workarounds},
 100         },
 101         {
 102                 name => 'BusyCursor',
 103                 cursor => '',
 104                 window => 0,
 105                 descr => q{Show/don't show the wait cursor in certain operations},
 106         },
 107         {
 108                 name => 'ButtonState',
 109                 cursor => '',
 110                 window => 0,
 111                 descr => q{Disable some titlebar button states (not recommended)},
 112         },
 113         {
 114                 name => 'ButtonStyle',
 115                 cursor => '',
 116                 window => 0,
 117                 descr => q{Define a window button look (will be reworked)},
 118         },
 119         {
 120                 name => 'ChangeDecor',
 121                 cursor => 'SELECT',
 122                 window => 1,
 123                 descr => q{Attach decor to a window (will be obsolete)},
 124         },
 125         {
 126                 name => 'ChangeMenuStyle',
 127                 cursor => '',
 128                 window => 0,
 129                 descr => q{Attach menu style to a menu (see MenuStyle)},
 130         },
 131         {
 132                 name => 'CleanupColorsets',
 133                 cursor => '',
 134                 window => 0,
 135                 descr => q{Reset all used colorsets with the default gray colors},
 136         },
 137         {
 138                 name => 'ClickTime',
 139                 cursor => '',
 140                 window => 0,
 141                 descr => q{Set a time in milliseconds for click and double click},
 142         },
 143         {
 144                 name => 'Close',
 145                 cursor => 'DESTROY',
 146                 window => 1,
 147                 descr => q{Try to Delete a window, if this fails, Destroy it},
 148         },
 149         {
 150                 name => 'ColorLimit',
 151                 cursor => '',
 152                 window => 0,
 153                 descr => q{Set limit on colors used (obsolete)},
 154         },
 155         {
 156                 name => 'ColormapFocus',
 157                 cursor => '',
 158                 window => 0,
 159                 descr => q{Change the colormap behaviour for low-depth X servers},
 160         },
 161         {
 162                 name => 'Colorset',
 163                 cursor => '',
 164                 window => 0,
 165                 descr => q{Manage colors used like fg, bg, image bg, gradient bg},
 166         },
 167         {
 168                 name => 'CopyMenuStyle',
 169                 cursor => '',
 170                 window => 0,
 171                 descr => q{Copy the existing menu style to new or existing one},
 172         },
 173         {
 174                 name => 'Current',
 175                 cursor => '',
 176                 window => 0,
 177                 descr => q{Operate on the currently focused window},
 178         },
 179         {
 180                 name => 'CursorMove',
 181                 cursor => '',
 182                 window => 0,
 183                 descr => q{Move the cursor pointer non interactively},
 184         },
 185         {
 186                 name => 'CursorStyle',
 187                 cursor => '',
 188                 window => 0,
 189                 descr => q{Define different cursor pointer shapes and colors},
 190         },
 191         {
 192                 name => 'DefaultColors',
 193                 cursor => '',
 194                 window => 0,
 195                 descr => q{Set colors for the feedback window (will be obsolete)},
 196         },
 197         {
 198                 name => 'DefaultColorset',
 199                 cursor => '',
 200                 window => 0,
 201                 descr => q{Set colors for the Move/Resize feedback window},
 202         },
 203         {
 204                 name => 'DefaultFont',
 205                 cursor => '',
 206                 window => 0,
 207                 descr => q{The default font to use (mainly for feedback window)},
 208         },
 209         {
 210                 name => 'DefaultIcon',
 211                 cursor => '',
 212                 window => 0,
 213                 descr => q{The default icon to use for iconified windows},
 214         },
 215         {
 216                 name => 'DefaultLayers',
 217                 cursor => '',
 218                 window => 0,
 219                 descr => q{Set StaysOnBottom, StaysPut, StaysOnTop layer numbers},
 220         },
 221         {
 222                 name => 'Delete',
 223                 cursor => 'DESTROY',
 224                 window => 1,
 225                 descr => q{Try to delete a window using the X delete protocol},
 226         },
 227         {
 228                 name => 'Deschedule',
 229                 cursor => '',
 230                 window => 0,
 231                 descr => q{Remove commands sheduled earlier using Schedule},
 232         },
 233         {
 234                 name => 'Desk',
 235                 cursor => '',
 236                 window => 0,
 237                 descr => q{(obsolete, use GotoDesk instead)},
 238         },
 239         {
 240                 name => 'DesktopName',
 241                 cursor => '',
 242                 window => 0,
 243                 descr => q{Define the desktop names used in WindowList, modules},
 244         },
 245         {
 246                 name => 'DesktopSize',
 247                 cursor => '',
 248                 window => 0,
 249                 descr => q{Set virtual desktop size in units of physical pages},
 250         },
 251         {
 252                 name => 'Destroy',
 253                 cursor => 'DESTROY',
 254                 window => 1,
 255                 descr => q{Kill a window without any warning to an application},
 256         },
 257         {
 258                 name => 'DestroyDecor',
 259                 cursor => '',
 260                 window => 0,
 261                 descr => q{Delete decor defined by AddToDecor (will be obsolete)},
 262         },
 263         {
 264                 name => 'DestroyFunc',
 265                 cursor => '',
 266                 window => 0,
 267                 descr => q{Delete function defined using AddToFunc},
 268         },
 269         {
 270                 name => 'DestroyMenu',
 271                 cursor => '',
 272                 window => 0,
 273                 descr => q{Delete menu defined using AddToMenu},
 274         },
 275         {
 276                 name => 'DestroyMenuStyle',
 277                 cursor => '',
 278                 window => 0,
 279                 descr => q{Delete menu style defined using MenuStyle},
 280         },
 281         {
 282                 name => 'DestroyModuleConfig',
 283                 cursor => '',
 284                 window => 0,
 285                 descr => q{Delete matching module config lines defined using "*"},
 286         },
 287         {
 288                 name => 'DestroyStyle',
 289                 cursor => '',
 290                 window => 0,
 291                 descr => q{Delete style defined using Style},
 292         },
 293         {
 294                 name => 'DestroyWindowStyle',
 295                 cursor => 'SELECT',
 296                 window => 1,
 297                 descr => q{Delete style defined using WindowStyle},
 298         },
 299         {
 300                 name => 'Direction',
 301                 cursor => '',
 302                 window => 0,
 303                 descr => q{Operate on the next window in the specified direction},
 304         },
 305         {
 306                 name => 'Echo',
 307                 cursor => '',
 308                 window => 0,
 309                 descr => q{Print message to stderr, mainly for debugging},
 310         },
 311         {
 312                 name => 'EchoFuncDefinition',
 313                 cursor => '',
 314                 window => 0,
 315                 descr => q{Print the definion of a function},
 316         },
 317         {
 318                 name => 'EdgeCommand',
 319                 cursor => '',
 320                 window => 0,
 321                 descr => q{Bind one or another screen edge to an fvwm action},
 322         },
 323         {
 324                 name => 'EdgeLeaveCommand',
 325                 cursor => '',
 326                 window => 0,
 327                 descr => q{Bind one or another screen edge to an fvwm action},
 328         },
 329         {
 330                 name => 'EdgeResistance',
 331                 cursor => '',
 332                 window => 0,
 333                 descr => q{Control viewport scrolling and window move over edge},
 334         },
 335         {
 336                 name => 'EdgeScroll',
 337                 cursor => '',
 338                 window => 0,
 339                 descr => q{Control how much of the viewport is scrolled if any},
 340         },
 341         {
 342                 name => 'EdgeThickness',
 343                 cursor => '',
 344                 window => 0,
 345                 descr => q{Control how closely to edge to run command/scrolling},
 346         },
 347         {
 348                 name => 'Emulate',
 349                 cursor => '',
 350                 window => 0,
 351                 descr => q{Only used to position the position/size window},
 352         },
 353         {
 354                 name => 'EscapeFunc',
 355                 cursor => '',
 356                 window => 0,
 357                 descr => q{Abort a wait or ModuleSynchonous command},
 358         },
 359         {
 360                 name => 'EwmhBaseStruts',
 361                 cursor => '',
 362                 window => 0,
 363                 descr => q{Define restricted areas of the screen},
 364         },
 365         {
 366                 name => 'EwmhNumberOfDesktops',
 367                 cursor => '',
 368                 window => 0,
 369                 descr => q{For ewmh pager, define number of desktops},
 370         },
 371         {
 372                 name => 'Exec',
 373                 cursor => '',
 374                 window => 0,
 375                 descr => q{Execute an external command},
 376         },
 377         {
 378                 name => 'ExecUseShell',
 379                 cursor => '',
 380                 window => 0,
 381                 descr => q{The shell to use to execute an external command},
 382         },
 383         {
 384                 name => 'FakeClick',
 385                 cursor => '',
 386                 window => 0,
 387                 descr => q{Generate a mouse click},
 388         },
 389         {
 390                 name => 'FakeKeypress',
 391                 cursor => '',
 392                 window => 0,
 393                 descr => q{Send a keyboard event to a window},
 394         },
 395         {
 396                 name => 'FlipFocus',
 397                 cursor => 'SELECT',
 398                 window => 1,
 399                 descr => q{Focus a window without rotating windowlist order},
 400         },
 401         {
 402                 name => 'Focus',
 403                 cursor => 'SELECT',
 404                 window => 1,
 405                 descr => q{Give focus to a window},
 406         },
 407         {
 408                 name => 'FocusStyle',
 409                 cursor => '',
 410                 window => 0,
 411                 descr => q{Configure focus and raise policy for windows},
 412         },
 413         {
 414                 name => 'Function',
 415                 cursor => '',
 416                 window => 0,
 417                 descr => q{Execute a user defined function, see AddToFunc},
 418         },
 419         {
 420                 name => 'GlobalOpts',
 421                 cursor => '',
 422                 window => 0,
 423                 descr => q{(obsolete, use corresponding Style * instead)},
 424         },
 425         {
 426                 name => 'GnomeButton',
 427                 cursor => '',
 428                 window => 0,
 429                 descr => q{Pass mouse button presses on root to GNOME program},
 430         },
 431         {
 432                 name => 'GnomeShowDesks',
 433                 cursor => '',
 434                 window => 0,
 435                 descr => q{Limit GNOME pager to the number of desks},
 436         },
 437         {
 438                 name => 'GotoDesk',
 439                 cursor => '',
 440                 window => 0,
 441                 descr => q{Switch viewport to another desk same page},
 442         },
 443         {
 444                 name => 'GotoDeskAndPage',
 445                 cursor => '',
 446                 window => 0,
 447                 descr => q{Switch viewport to another desk and page},
 448         },
 449         {
 450                 name => 'GotoPage',
 451                 cursor => '',
 452                 window => 0,
 453                 descr => q{Switch viewport to another page same desk},
 454         },
 455         {
 456                 name => 'HideGeometryWindow',
 457                 cursor => '',
 458                 window => 0,
 459                 descr => q{Hide/show the position/size window},
 460         },
 461         {
 462                 name => 'HilightColor',
 463                 cursor => '',
 464                 window => 0,
 465                 descr => q{(obsolete, use Style * HighlightFore/Back)},
 466         },
 467         {
 468                 name => 'HilightColorset',
 469                 cursor => '',
 470                 window => 0,
 471                 descr => q{(obsolete, use Style * HighlightColorset)},
 472         },
 473         {
 474                 name => 'IconFont',
 475                 cursor => '',
 476                 window => 0,
 477                 descr => q{(obsolete, use Style * IconFont)},
 478         },
 479         {
 480                 name => 'Iconify',
 481                 cursor => 'SELECT',
 482                 window => 1,
 483                 descr => q{Change iconification status of a window (minimize)},
 484         },
 485         {
 486                 name => 'IconPath',
 487                 cursor => '',
 488                 window => 0,
 489                 descr => q{(obsolete, use ImagePath instead)},
 490         },
 491         {
 492                 name => 'IgnoreModifiers',
 493                 cursor => '',
 494                 window => 0,
 495                 descr => q{Modifiers to ignore on mouse and key bindings},
 496         },
 497         {
 498                 name => 'ImagePath',
 499                 cursor => '',
 500                 window => 0,
 501                 descr => q{Directories to search for images},
 502         },
 503         {
 504                 name => 'KeepRc',
 505                 cursor => '',
 506                 window => 0,
 507                 descr => q{Do not modify the previous command return code},
 508         },
 509         {
 510                 name => 'Key',
 511                 cursor => '',
 512                 window => 0,
 513                 descr => q{Bind or unbind a key to an fvwm action},
 514         },
 515         {
 516                 name => 'KillModule',
 517                 cursor => '',
 518                 window => 0,
 519                 descr => q{Stops an fvwm module},
 520         },
 521         {
 522                 name => 'Layer',
 523                 cursor => 'SELECT',
 524                 window => 1,
 525                 descr => q{Change the layer of a window},
 526         },
 527         {
 528                 name => 'LocalePath',
 529                 cursor => '',
 530                 window => 0,
 531                 descr => q{Directories/domains to search for locale data},
 532         },
 533         {
 534                 name => 'Lower',
 535                 cursor => 'SELECT',
 536                 window => 1,
 537                 descr => q{Lower a window within a layer},
 538         },
 539         {
 540                 name => 'Maximize',
 541                 cursor => 'SELECT',
 542                 window => 1,
 543                 descr => q{Toggle maximal-size status of a window},
 544         },
 545         {
 546                 name => 'Menu',
 547                 cursor => '',
 548                 window => 0,
 549                 descr => q{Display (post) a menu},
 550         },
 551         {
 552                 name => 'MenuStyle',
 553                 cursor => '',
 554                 window => 0,
 555                 descr => q{Control appearance and behavior of a menu},
 556         },
 557         {
 558                 name => 'Module',
 559                 cursor => '',
 560                 window => 0,
 561                 descr => q{Invoke an fvwm module},
 562         },
 563         {
 564                 name => 'ModuleListenOnly',
 565                 cursor => '',
 566                 window => 0,
 567                 descr => q{Invoke an fvwm module},
 568         },
 569         {
 570                 name => 'ModulePath',
 571                 cursor => '',
 572                 window => 0,
 573                 descr => q{Modify the directories to search for an fvwm module},
 574         },
 575         {
 576                 name => 'ModuleSynchronous',
 577                 cursor => '',
 578                 window => 0,
 579                 descr => q{Invoke an fvwm module synchronously},
 580         },
 581         {
 582                 name => 'ModuleTimeout',
 583                 cursor => '',
 584                 window => 0,
 585                 descr => q{Set timeout value for response from module},
 586         },
 587         {
 588                 name => 'Mouse',
 589                 cursor => '',
 590                 window => 0,
 591                 descr => q{Bind or unbind a mouse button press to an fvwm action},
 592         },
 593         {
 594                 name => 'Move',
 595                 cursor => 'MOVE',
 596                 window => 1,
 597                 descr => q{Move a window},
 598         },
 599         {
 600                 name => 'MoveThreshold',
 601                 cursor => '',
 602                 window => 0,
 603                 descr => q{Set number of pixels in a click and a hold vs. a drag},
 604         },
 605         {
 606                 name => 'MoveToDesk',
 607                 cursor => 'SELECT',
 608                 window => 1,
 609                 descr => q{Move a window to another desk same page},
 610         },
 611         {
 612                 name => 'MoveToPage',
 613                 cursor => 'SELECT',
 614                 window => 1,
 615                 descr => q{Move a window to another page same desk},
 616         },
 617         {
 618                 name => 'MoveToScreen',
 619                 cursor => 'SELECT',
 620                 window => 1,
 621                 descr => q{Move a window to another Xinerama screen},
 622         },
 623         {
 624                 name => 'Next',
 625                 cursor => '',
 626                 window => 0,
 627                 descr => q{Operate on the next window matching conditions},
 628         },
 629         {
 630                 name => 'None',
 631                 cursor => '',
 632                 window => 0,
 633                 descr => q{Perform command if no window matches conditions},
 634         },
 635         {
 636                 name => 'Nop',
 637                 cursor => '',
 638                 window => 0,
 639                 descr => q{Do nothing (used internally)},
 640         },
 641         {
 642                 name => 'NoWindow',
 643                 cursor => '',
 644                 window => 0,
 645                 descr => q{Prefix that runs a command without a window context},
 646         },
 647         {
 648                 name => 'OpaqueMoveSize',
 649                 cursor => '',
 650                 window => 0,
 651                 descr => q{Set maximum size window fvwm should move opaquely},
 652         },
 653         {
 654                 name => 'Pick',
 655                 cursor => 'SELECT',
 656                 window => 1,
 657                 descr => q{Prefix to force a window context, prompted if needed},
 658         },
 659         {
 660                 name => 'PipeRead',
 661                 cursor => '',
 662                 window => 0,
 663                 descr => q{Exec system command interpret output as fvwm commands},
 664         },
 665         {
 666                 name => 'PixmapPath',
 667                 cursor => '',
 668                 window => 0,
 669                 descr => q{(obsolete, use ImagePath instead)},
 670         },
 671         {
 672                 name => 'PlaceAgain',
 673                 cursor => 'SELECT',
 674                 window => 1,
 675                 descr => q{Replace a window using initial window placement logic},
 676         },
 677         {
 678                 name => 'PointerKey',
 679                 cursor => '',
 680                 window => 0,
 681                 descr => q{Bind an action to a key based on pointer not focus},
 682         },
 683         {
 684                 name => 'PointerWindow',
 685                 cursor => '',
 686                 window => 0,
 687                 descr => q{Operate on window under pointer if it meets conditions},
 688         },
 689         {
 690                 name => 'Popup',
 691                 cursor => '',
 692                 window => 0,
 693                 descr => q{Display (pop-up) a menu, see also Menu},
 694         },
 695         {
 696                 name => 'Prev',
 697                 cursor => '',
 698                 window => 0,
 699                 descr => q{Operate on the precious window matching conditions},
 700         },
 701         {
 702                 name => 'PrintInfo',
 703                 cursor => '',
 704                 window => 0,
 705                 descr => q{Print information about the state of fvwm},
 706         },
 707         {
 708                 name => 'PropertyChange',
 709                 cursor => '',
 710                 window => 0,
 711                 descr => q{Internal, used for inter-module communication},
 712         },
 713         {
 714                 name => 'Quit',
 715                 cursor => '',
 716                 window => 0,
 717                 descr => q{Exit fvwm},
 718         },
 719         {
 720                 name => 'QuitScreen',
 721                 cursor => '',
 722                 window => 0,
 723                 descr => q{Stop managing the specified screen},
 724         },
 725         {
 726                 name => 'QuitSession',
 727                 cursor => '',
 728                 window => 0,
 729                 descr => q{Ask session manager to shut down itself and fvwm},
 730         },
 731         {
 732                 name => 'Raise',
 733                 cursor => 'SELECT',
 734                 window => 1,
 735                 descr => q{Raise a window in a layer},
 736         },
 737         {
 738                 name => 'RaiseLower',
 739                 cursor => 'SELECT',
 740                 window => 1,
 741                 descr => q{Alternately raise or lower a window in a layer},
 742         },
 743         {
 744                 name => 'Read',
 745                 cursor => '',
 746                 window => 0,
 747                 descr => q{Read fvwm commands from a file},
 748         },
 749         {
 750                 name => 'ReadWriteColors',
 751                 cursor => '',
 752                 window => 0,
 753                 descr => q{Used for colorset speed hacks (will be removed?)},
 754         },
 755         {
 756                 name => 'Recapture',
 757                 cursor => '',
 758                 window => 0,
 759                 descr => q{Reapply styles to all windows (will be obsolete)},
 760         },
 761         {
 762                 name => 'RecaptureWindow',
 763                 cursor => 'SELECT',
 764                 window => 1,
 765                 descr => q{Reapply styles to one window (will be obsolete)},
 766         },
 767         {
 768                 name => 'Refresh',
 769                 cursor => '',
 770                 window => 0,
 771                 descr => q{Cause all windows to redraw themselves},
 772         },
 773         {
 774                 name => 'RefreshWindow',
 775                 cursor => 'SELECT',
 776                 window => 1,
 777                 descr => q{Cause one window to redraw itself},
 778         },
 779         {
 780                 name => 'Repeat',
 781                 cursor => '',
 782                 window => 0,
 783                 descr => q{Repeat (very unreliably) the last command, don't use},
 784         },
 785         {
 786                 name => 'Resize',
 787                 cursor => 'RESIZE',
 788                 window => 1,
 789                 descr => q{Cause a window to be resized},
 790         },
 791         {
 792                 name => 'ResizeMaximize',
 793                 cursor => 'RESIZE',
 794                 window => 1,
 795                 descr => q{Resize a window and mark window as maximized},
 796         },
 797         {
 798                 name => 'ResizeMove',
 799                 cursor => 'RESIZE',
 800                 window => 1,
 801                 descr => q{Resize and move in one operation},
 802         },
 803         {
 804                 name => 'ResizeMoveMaximize',
 805                 cursor => 'RESIZE',
 806                 window => 1,
 807                 descr => q{Resize and move in one operation and mark maximized},
 808         },
 809         {
 810                 name => 'RestackTransients',
 811                 cursor => 'SELECT',
 812                 window => 1,
 813                 descr => q{Regroup the window transients in the stack},
 814         },
 815         {
 816                 name => 'Restart',
 817                 cursor => '',
 818                 window => 0,
 819                 descr => q{Restart itself or replace with another window manager},
 820         },
 821         {
 822                 name => 'SaveQuitSession',
 823                 cursor => '',
 824                 window => 0,
 825                 descr => q{Cause session manager to save and shutdown fvwm},
 826         },
 827         {
 828                 name => 'SaveSession',
 829                 cursor => '',
 830                 window => 0,
 831                 descr => q{Cause session manager to save the session},
 832         },
 833         {
 834                 name => 'ScanForWindow',
 835                 cursor => '',
 836                 window => 0,
 837                 descr => q{Operate on the matching window in the given direction},
 838         },
 839         {
 840                 name => 'Schedule',
 841                 cursor => '',
 842                 window => 0,
 843                 descr => q{Run an fvwm command after a delay},
 844         },
 845         {
 846                 name => 'Scroll',
 847                 cursor => '',
 848                 window => 0,
 849                 descr => q{Scroll the desktop viewport},
 850         },
 851         {
 852                 name => 'Send_ConfigInfo',
 853                 cursor => '',
 854                 window => 0,
 855                 descr => q{Internal, used for module communication},
 856         },
 857         {
 858                 name => 'Send_Reply',
 859                 cursor => '',
 860                 window => 0,
 861                 descr => q{Internal, used for module communication},
 862         },
 863         {
 864                 name => 'Send_WindowList',
 865                 cursor => '',
 866                 window => 0,
 867                 descr => q{Internal, used for module communication},
 868         },
 869         {
 870                 name => 'SendToModule',
 871                 cursor => '',
 872                 window => 0,
 873                 descr => q{Send a string (action) to a module},
 874         },
 875         {
 876                 name => 'set_mask',
 877                 cursor => '',
 878                 window => 0,
 879                 descr => q{Internal, used for module communication},
 880         },
 881         {
 882                 name => 'set_nograb_mask',
 883                 cursor => '',
 884                 window => 0,
 885                 descr => q{Internal, used for module communication},
 886         },
 887         {
 888                 name => 'set_sync_mask',
 889                 cursor => '',
 890                 window => 0,
 891                 descr => q{Internal, used for module communication},
 892         },
 893         {
 894                 name => 'SetAnimation',
 895                 cursor => '',
 896                 window => 0,
 897                 descr => q{Control animated moves and menus},
 898         },
 899         {
 900                 name => 'SetEnv',
 901                 cursor => '',
 902                 window => 0,
 903                 descr => q{Set an environment variable},
 904         },
 905         {
 906                 name => 'Silent',
 907                 cursor => '',
 908                 window => 0,
 909                 descr => q{Suppress errors on command, avoid window selection},
 910         },
 911         {
 912                 name => 'SnapAttraction',
 913                 cursor => '',
 914                 window => 0,
 915                 descr => q{Control attraction of windows during move},
 916         },
 917         {
 918                 name => 'SnapGrid',
 919                 cursor => '',
 920                 window => 0,
 921                 descr => q{Control grid used with SnapAttraction},
 922         },
 923         {
 924                 name => 'State',
 925                 cursor => 'SELECT',
 926                 window => 1,
 927                 descr => q{Control user defined window states},
 928         },
 929         {
 930                 name => 'Stick',
 931                 cursor => 'SELECT',
 932                 window => 1,
 933                 descr => q{Change window stickyness},
 934         },
 935         {
 936                 name => 'StickAcrossDesks',
 937                 cursor => 'SELECT',
 938                 window => 1,
 939                 descr => q{Change window stickyness on a desk basis},
 940         },
 941         {
 942                 name => 'StickAcrossPages',
 943                 cursor => 'SELECT',
 944                 window => 1,
 945                 descr => q{Change window stickyness on a page basis},
 946         },
 947         {
 948                 name => 'Stroke',
 949                 cursor => '',
 950                 window => 0,
 951                 descr => q{Bind a stroke to an fvwm action},
 952         },
 953         {
 954                 name => 'StrokeFunc',
 955                 cursor => '',
 956                 window => 0,
 957                 descr => q{Record stroke and execute corresponding stroke action},
 958         },
 959         {
 960                 name => 'Style',
 961                 cursor => '',
 962                 window => 0,
 963                 descr => q{Set attributes of windows that match a pattern},
 964         },
 965         {
 966                 name => 'TearMenuOff',
 967                 cursor => '',
 968                 window => 0,
 969                 descr => q{Convert a menu to a window, for use in menu items},
 970         },
 971         {
 972                 name => 'Test',
 973                 cursor => '',
 974                 window => 0,
 975                 descr => q{Execute command if conditions are met},
 976         },
 977         {
 978                 name => 'TestRc',
 979                 cursor => '',
 980                 window => 0,
 981                 descr => q{Conditional switch (may be changed)},
 982         },
 983         {
 984                 name => 'ThisWindow',
 985                 cursor => '',
 986                 window => 0,
 987                 descr => q{Operate on the context window if it meets conditions},
 988         },
 989         {
 990                 name => 'Title',
 991                 cursor => '',
 992                 window => 0,
 993                 descr => q{Insert title into a menu},
 994         },
 995         {
 996                 name => 'TitleStyle',
 997                 cursor => '',
 998                 window => 0,
 999                 descr => q{Control window title},
1000         },
1001         {
1002                 name => 'UnsetEnv',
1003                 cursor => '',
1004                 window => 0,
1005                 descr => q{Remove an environment variable},
1006         },
1007         {
1008                 name => 'UpdateDecor',
1009                 cursor => '',
1010                 window => 0,
1011                 descr => q{Update window decor (obsolete and not needed anymore)},
1012         },
1013         {
1014                 name => 'UpdateStyles',
1015                 cursor => '',
1016                 window => 0,
1017                 descr => q{Cause styles to update while still in a function},
1018         },
1019         {
1020                 name => 'Wait',
1021                 cursor => '',
1022                 window => 0,
1023                 descr => q{Pause until a matching window appears},
1024         },
1025         {
1026                 name => 'WarpToWindow',
1027                 cursor => 'SELECT',
1028                 window => 1,
1029                 descr => q{Warp the pointer to a window},
1030         },
1031         {
1032                 name => 'WindowFont',
1033                 cursor => '',
1034                 window => 0,
1035                 descr => q{(obsolete, use Style * Font)},
1036         },
1037         {
1038                 name => 'WindowId',
1039                 cursor => '',
1040                 window => 0,
1041                 descr => q{Execute command for window matching the windowid},
1042         },
1043         {
1044                 name => 'WindowList',
1045                 cursor => '',
1046                 window => 0,
1047                 descr => q{Display the window list as a menu to select a window},
1048         },
1049         {
1050                 name => 'WindowShade',
1051                 cursor => 'SELECT',
1052                 window => 1,
1053                 descr => q{Shade/unshade a window},
1054         },
1055         {
1056                 name => 'WindowShadeAnimate',
1057                 cursor => '',
1058                 window => 0,
1059                 descr => q{(obsolete, use Style * WindowShadeSteps)},
1060         },
1061         {
1062                 name => 'WindowStyle',
1063                 cursor => 'SELECT',
1064                 window => 1,
1065                 descr => q{Set styles on the selected window},
1066         },
1067         {
1068                 name => 'Xinerama',
1069                 cursor => '',
1070                 window => 0,
1071                 descr => q{Control Xinerama support},
1072         },
1073         {
1074                 name => 'XineramaPrimaryScreen',
1075                 cursor => '',
1076                 window => 0,
1077                 descr => q{Identify Xinerama primary screen},
1078         },
1079         {
1080                 name => 'XineramaSls',
1081                 cursor => '',
1082                 window => 0,
1083                 descr => q{Control single logical screen support},
1084         },
1085         {
1086                 name => 'XineramaSlsScreens',
1087                 cursor => '',
1088                 window => 0,
1089                 descr => q{Configure layout for single logical screen},
1090         },
1091         {
1092                 name => 'XineramaSlsSize',
1093                 cursor => '',
1094                 window => 0,
1095                 descr => q{Configure layout for single logical screen sizes},
1096         },
1097         {
1098                 name => 'XorPixmap',
1099                 cursor => '',
1100                 window => 0,
1101                 descr => q{Use a pixmap for move/resize rubber-band},
1102         },
1103         {
1104                 name => 'XorValue',
1105                 cursor => '',
1106                 window => 0,
1107                 descr => q{Change bits used for move/resize rubber-band},
1108         },
1109         {
1110                 name => 'XSync',
1111                 cursor => '',
1112                 window => 0,
1113                 descr => q{For debugging, send all pending requests to X server},
1114         },
1115         {
1116                 name => 'XSynchronize',
1117                 cursor => '',
1118                 window => 0,
1119                 descr => q{For debugging, cause all X requests to be synchronous},
1120         },
1121 );
1122
1123 1;
1124
1125 __END__
1126
1127 =head1 NAME
1128
1129 FVWM::Commands - lists all available fvwm commands
1130
1131 =head1 DESCRIPTION
1132
1133 This class is autogenerated from the fvwm sources.
1134
1135 It may be used to get a list of all available fvwm commands including the
1136 command name, its short description and some other command properties.
1137
1138 =head1 USAGE
1139
1140     use lib `fvwm-perllib dir`;
1141     use FVWM::Commands;
1142     use POSIX;
1143
1144     my $date = strftime("%d-%b-%Y", gmtime($FVWM::Commands::TIME));
1145     my $version = $FVWM::Commands::VERS;
1146     print "The recognized commands for fvwm $version as of $date:\n\n";
1147     foreach my $command (@FVWM::Commands::LIST) {
1148         printf "  %-21s - %s\n", $command->{name}, $command->{descr};
1149     }
1150
1151 =head1 PUBLIC CONSTANTS
1152
1153 =over 4
1154
1155 =item $VERS
1156
1157 The fvwm version number at the generation time like "2.6.0" plus the info
1158 that may indicate that this is not a final version, but a cvs snapshot.
1159
1160 =item $TIME
1161
1162 The unix time of the command list generation.
1163
1164 Example:
1165
1166     print "The fvwm command list found on your system was generated "
1167         . (time() - $FVWM::Commands::TIME) / 86400 . " days ago\n";
1168
1169 =item @LIST
1170
1171 The command list that is an array of hashes with keys I<name>, I<cursor>,
1172 I<descr> (string) and I<window> (boolean).
1173
1174 I<name> may be special, like "+", "#" and "*".  Other names usually contain
1175 only isalpha characters, like B<Move>, B<SendToModule>.
1176
1177 I<cursor> may be either empty or the cursor context used in B<CursorStyle>
1178 (like "SELECT" or "MOVE"), associated with the command.
1179
1180 I<descr> is a short one line description of the command.
1181
1182 I<window> is true for commands that need a window.
1183
1184 Example:
1185
1186     # get command names only
1187     @command_names = map { $_->{name} } @FVWM::Commands::LIST;
1188
1189 =back
1190
1191 =head1 AUTHOR
1192
1193 Mikhael Goikhman <migo@homemail.com>.
1194
1195 =head1 SEE ALSO
1196
1197 For more information about the commands themselves, see fvwm(1).
1198
1199 =cut