Functions(1)             AfterStep X11 window manager             Functions(1)



NAME
       Functions - built in AfterStep functions AfterStepAutoExecBase
       ConfigurationFunction





CONFIGURATION OPTIONS
       Background"name" filenameChange Background image to specified
       fileCopies image file specified by filename into user's non-
       configurable directory. Depending on Background configuration in look
       file, this may not have any effect.  BackgroundForeign"name"
       filenameChange Background image to specified fileWorks same as
       Background but generates minipixmap from the image automagically. Also
       tries to determine if background should be fullscreen and crops/scales
       it to the proper size.  BeepMake the window manager issue a beep -
       pretty useful eh? :) BookmarkWindow"name" new_bookmarkPlaces a bookmark
       on the selected window, to be used later on to get back to that window.
       Category"category-name"Generate a menu from all the members belonging
       to specified desktop category. For example Category "Modules", generate
       a menu of all AfterStep modules in
       afterstep/applications/modules.desktop CategoryTreeFIXME: add proper
       description here.  ChangeColorscheme"name" filenameChange Color Scheme
       to specified fileCopies color scheme configuration file specified by
       filename into user's non-configurable directory.  ChangeFeel"name"
       filenameChange Feel to specified fileCopies feel configuration file
       specified by filename into user's non-configurable directory.
       ChangeLook"name" filenameChange Look to specified fileCopies Look
       configuration file specified by filename into user's non-configurable
       directory, to be used by AfterStep.  ChangeTheme"name" file_nameSets
       current theme config file. Such config file may include settings for
       look, feel, menu, autoexec and any module.  ChangeThemeFileInstalls a
       theme from a provided .tar, .tar.gz, or .tar.bz2 AfterStep theme file.
       ChangeWindowDown ["name" window_name]Causes the pointer to move to the
       previous window in the list of windows for whichCirculateSkiphas not
       not been specified.The mouse will jump (going backwards) to the first
       window whose name (or icon name or class) matcheswindow_name.
       The"name"entry then becomes required, but serves no purpose if the
       function is not called from a menu or popup.  ChangeWindowUp ["name"
       window_name]Causes the pointer to move to the previous window in the
       list of windows for whichCirculateSkiphas not not been specified.The
       mouse will jump to the first window whose name (or icon name or class)
       matcheswindow_name. The"name"entry then becomes required, but serves no
       purpose if the function is not called from a menu or popup.  Close
       ["name"]First sends the WM_DELETE message, if this is not understood,
       then theXKillClient(3)is sent to the window.  CursorMovehorizontal
       verticalMoves the mouse pointer byhorizontalviews in the x-direction,
       andverticalviews in the y-direction. Either or both entries may be
       negative. Bothhorizontalandverticalvalues are expressed in percent of
       pages, so 100 would be one full view.The CursorMove function should not
       be called from pop-up menus.  Delete ["name"]Sends a WM_DELETE message
       to a window asking that it remove itself, frequently causing the
       application to exit.  Deskarg1[arg2]Changes current desk to another
       desk as surmised from the arguments supplied. If onlyarg1is specified
       and is non-zero, then the current desk will become "desk + arg1"
       andarg2is ignored. Ifarg1is zero, thenarg2must be specified or no desk
       change will occur; andarg2will specify the desk to switch to. Desk
       numbers are determined dynamically and must be between 2147483647 and
       -2147483648; meaning they can also be negative.  DesktopEntryFIXME: add
       proper description here.  Destroy ["name"]Sends theXKillClient(3)to a
       window. Guaranteed to get rid of the window.  EndFunctionTerminates a
       Complex Function definition.  EndPopupTerminates a Popup definition.
       Exec"name"command[-options]Specifies a sub process to initiate.
       The"name"is required for ease of parsing. Thecommandis the command or
       application to be invoked along with any desired-options.
       ExecBrowser"name" URLOpen URL in web browser.  ExecEditor"name"
       filenameOpen file in text editor.

       ExecInTerm"name"command[-options]Specifies a sub process to initiate.
       It is similar to Exec , though targeted at programms that need a
       terminal to run. The following terminal emulators are tried in order:
       aterm, rxvt, eterm, xterm.  FocusMoves the view or window as needed to
       make the selected window visible. Sets the keyboard focus to the
       selected window. Raises the window if 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.  Folder "folder-name"Defines a slide-out
       folder inside the current folder. The following button definitions will
       be placed inside of the subfolder, until a*Wharf ~Folderline is
       encountered. See theEXAMPLESsection below for an example. Folders may
       be nested.This is a Wharf specific Function.  FullscreenToggle window
       Fullscreen state. Will disregard any AvoidCover windows and will try to
       make window as big as the screen unless it's hints set certain
       limitation on size. Window in Fullscreen mode cannot be Maximized.
       Function"function_name"There are also two situations where this might
       occur as well; as a function definition stanza, or in calling a
       previously defined function decleration.Function"function_name"built-
       in_file"action"[argument] EndFunctionSpecifies the definition of a
       complex function"function_name", which can later be bound to a mouse
       button or key using"function_name"to recall this declaration.built-
       in_commandspecifies which command will be performed, taking its syntax
       from this list of Built-In Commands/Functions."action"specifies the
       action to take followed by any additionalargumentsneeded by thebuilt-
       in_command. Menus can be specified by using thePopupcommand, as long as
       the menu was defined earlier in the configuration file.The
       triggeractionswhich 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 if a window has not
       been selected. If there are actions other than immediate
       ones,afterstepwill wait to see if 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.Two special functions exist: InitFunction and
       RestartFunction. The InitFunction will be called whenafterstepis
       started for the first time in any X session, and can be used to start
       modules and begin programs. The RestartFunction will be called
       whenafterstepis restarted. It can be used to re-start modules but
       probably should not be used to start programs. These two functions are
       defined in theautoexecfile.When calling a previously defined Function
       or a Function from a key-stroke combination, Function is simply used as
       a built-in command using the previously defined"action"from the
       samefunction_name.Functionbuilt-in_command"action"function_nameRefer to
       thefeel.namefiles and below in EXAMPLES for examples.  GetHelpRuns
       afterstepdoc script, that attempts to guess which web browser is
       available on the system, and then launches it to display HTML
       documentation for AfterStep.  GoToBookmark["name" window_bookmark
       ]Focuses window specified by previously placed window_bookmark.
       GotoDeskViewportDesk+Vx+VyChanges both current desk and viewport.
       GotoPagex yMoves the desktop view to pagex y. 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 theDeskTopSizecommand detailed
       in thePager(1)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 theDeskTopSizecommand.The GotoPage function should not be
       used in a pop-up menu.  Iconify ["name"] [value]Iconifies a window if
       it is not already iconified, or de-iconifies it if it is already
       iconified. If the optional argumentvalueis 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.  InstallBackground"name" filenameCopies specified file to
       ~/.afterstep/backgrounds/ directory, so that it will show up in the
       menu, to be used for Root background.  InstallColorscheme"name"
       filenameCopies specified file to ~/.afterstep/colorschemes/ directory,
       so that it will show up in the menu, to be used as color scheme.
       InstallFeel"name" filenameCopies specified file to ~/.afterstep/feels/
       directory, so that it will show up in the menu.  InstallFont"name"
       filenameCopies specified TTF file to ~/.afterstep/desktop/fonts/
       directory, so that it could be used in look configuration.
       InstallIcon"name" filenameCopies specified image file to
       ~/.afterstep/desktop/icons/ directory, so that it could be used in look
       and database configuration.  InstallLook"name" filenameCopies specified
       look file to ~/.afterstep/looks/ directory, so that it could be
       selected from the menu.  InstallThemeFile"name" filenameCopies
       specified theme file to ~/.afterstep/themes/ directory, so that it
       could be selected from the menu.  InstallTile"name" filenameCopies
       specified image file to ~/.afterstep/desktop/tiles/ directory, so that
       it could be used in look and database configuration.
       KIPCsendMessageAllSends a signal to all KDE applications, refreshing
       their visual properties.  KillAllModulesByNameKills AfterStep modules
       with a provided matching name.  KillModuleByName"name" modulenameKill
       module with specified name.  LargeMiniPixmappixmapSpecifies 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
       MiniPixmap when it is not desired to scale-down a pixmap image. Pixmap
       images are full-size. Opposite is SmallMiniPixmap.See Also: MiniPixmap,
       SmallMiniPixmap, MenuMiniPixmaps.  Lower ["name"]Allows the user to
       lower a window.  MaxSwallow "window-name"commandLikeSwallow, except the
       button will be resized to fit the application.This is a Wharf specific
       Function.  MaxSwallowModule "window-name"commandLikeMaxSwallow, except
       thecommandis an AfterStep module.This is a Wharf specific Function.
       Maximize ["name"] [horizontal vertical]Causes the window to alternately
       switch from a full-screen size to its normal size. Specifying the
       optional arguments ofhorizontalandvertical, control can be attained as
       to the percentage of the full screen that the new size of the window
       becomes. Ifhorizontal> 0, then the horizontal dimension of the window
       will be set to horizontal*screen_width/100. The vertical resizing is
       similar. Values larger than 100 can be used with caution. The defaults
       forhorizontalandverticalare 100s (ie, fullscreen).
       MiniPixmappixmapSpecifies 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.See Also: MinipixmapSize, LargeMiniPixmap,
       SmallMiniPixmap, MenuMiniPixmaps.  ModuleModuleName[arguments]Specifies
       thatModuleNameshould be spawned.Currently, many modules are included
       withafterstep.Wharf(1x)andPager(1x)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 byafterstepprior
       to restarts and quits, if possible.  Move ["name"]Allows the user to
       move a window or iconified app.  Nop ""Inserts a horizontal line (<HR>
       type html line) in a menu entry list.Nop "name"Inserts anamein the
       menu, stippled (disabled and grayed-out).  PasteSelectionThis function
       allows for substitute of X clipboard copy-pasting if application is
       missing it.  PinMenu["name"]Pins menu on desktop.
       PopUp"popup_name"There are two situations where this might occur; as a
       popup menu stanza definition, or in calling a previously defined menu
       declaration.Popup"popup_name"built-in_command"name"[argument]
       EndPopupSpecfies the definition of a complex menu popup"popup_name",
       which can be bound to a mouse button or key using"popup_name"to recall
       this declaration.built-in_commandspecifies which command will be
       performed, utilizing it's syntax from this list of Built-In
       Commands/Functions."name"specifies the name which will appear within
       the menu for the given item, and additionally anyargumentsneeded by
       thebuilt-in_command. The Popup definition ends with the keyword
       EndPopup. Sub-menus can be created by calling the Popup built-in within
       another Popup declaration, as long as that sub-menu was defined earlier
       in the configuration file.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 if the user presses the
       corresponding key, then that item will be activated as if 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.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 WindowList when
       it is displayed.When calling a previously defined menu or a menu from a
       key-stroke combination, Popup is simply used as a built-in command with
       the"name"referring to the previously defined Popup definitions
       name.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
       thefeel.namefiles and below in EXAMPLES for examples.  PutOnBackMoves
       the target window to the bottom of its layer, or down one layer if it
       is already at the bottom.  PutOnTopMoves the target window to the top
       of its layer, or up one layer if it is already at the top.
       QuickRestartlook|feel|look+feelCauses AfterStep to reload specified
       config.  Quit ["name"]Exitsafterstep, generally causing X to exit too.
       Raise ["name"]Allows the user to raise a window.  RaiseLower
       ["name"]Alternately raises and lowers a window; i.e. if it's raised,
       the window will lower, and vice versa.  Refresh ["name"]Causes all
       windows on the screen to re-draw themselves.  Resize ["name"]Allows the
       user to resize a window.
       Restart"name"WindowManagerNameRestartsX(1)with the
       givenWindowManagerName. IfWindowManagerNameisafterstep, then this
       forcesafterstepto reread all of its configuration files and reinitiate
       the session. IfWindowManagerNameis not in the default search path, then
       the full path name should be given.  RestartModuleByNameRestarts
       AfterStep modules with a provided matching name.
       RestartModuleListRestarts all AfterStep modules.  SET_FLAGSDo not use.
       Reserved for use by AfterStep modules to set communication flags -
       identifying which messages module wishes to receive.  SET_MASKDo not
       use. Reserved for use by AfterStep modules.  SET_NAMEDo not use.
       Reserved for use by AfterStep modules to identify themselves to
       AfterStep.  SaveWorkspace"name" file_nameWrite 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 ICCCM properties on its
       windows.  Scrollhorizontal verticalScrolls the desktop's view
       byhorizontalpages in the x-direction, andverticalpages in the y-
       direction. Either or both entries may be negative.
       Bothhorizontalandverticalvalues are expressed in percent of pages, so
       100 would be one full page. Normally, scrolling stops at the edge of
       the desktop. If thehorizontalandverticalvalues are multiplied by 1000,
       then scrolling will wrap around at the edge of the desktop.The scroll
       function should not be called from pop-up menus.  Send_WindowListThis
       Function is used by modules to obtain list of open windows.  SetFIXME:
       add proper description here.  SetLayerlayerMoves the target window to
       layerlayer.  Shade ["name"]Emulates the MacOS WindowShade feature. Once
       activated the window will become a titlebar only.
       SignalReloadGTKRCFileForces all GTK apps to reload the gtkrc files.
       SizewidthheightSets the size of the associated button, overriding any
       other size consideration.TheWharfbutton size depends on several things.
       The order of precedence is:1) Size definition 2) MaxSwallow'd window
       size 3)WharfPixmapsize 4) Use 64x64.This is a Wharf specific Function.
       SmallMiniPixmappixmapSpecifies 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 MiniPixmap; 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.See Also:
       MiniPixmap, LargeMiniPixmap, MenuMiniPixmaps.  Stick ["name"]Makes a
       window sticky (stays on screen when desks/views are switched) if it is
       not already sticky, or non-sticky if it is already sticky.
       StopModuleListStops all AfterStep modules.  Swallow "window-
       name"commandCausesWharfto runcommand, capture the first window whose
       name or resource iswindow-name, and display it in the associated
       button. The application window will be shrunk to fit the size of the
       button.This is a Wharf specific Function.  SwallowModule "window-
       name"commandLikeSwallow, except thecommandis an AfterStep module.This
       is a Wharf specific Function.  SwallowWindow"pattern" shell_commandwill
       cause already opened window to be swallowed, while just Swallow will
       run application, if there are no windows matching pattern
       TakeFrameShot"name" filenameGrabs screenshot of the client window
       including frame decorations and save it in specifyed files.
       TakeScreenShot"name" filenameGrabs screenshot of the entire screen and
       save it in specifyed files.  TakeWindowShot"name" filenameGrabs
       screenshot of the client window excluding frame decorations and save it
       in specifyed files.  TestDo not use. Internal function.
       Title"name"Insert a title line of headingnameinto a popup or menu.
       ToggleLayerlayer1layer2Specifies that if the window is inlayer1, it
       should be placed inlayer2. Otherwise, it is placed inlayer1. In either
       case, the window will be placed on top of other windows in the target
       layer.  TogglePage ["name"]Temporarily disablesEdgeScroll. Edge
       scrolling can be re-enabled by calling this again.  TransientSpecifies
       that this button will not perform any action, will not be pushable, and
       will not have an associated balloon.  UNLOCKDo not use. Internal
       function.  Waitapp_nameThis is intended to be used inafterstepfunctions
       only. It causes execution of a function to pause until a new window
       namedapp_nameappears.afterstepremains fully functional during a wait.
       This is particularly useful in the InitFunction and RestartFunction, if
       you are trying to start windows on specific desktops.  WarpBack ["name"
       window_name]Same asChangeWindowDown, but uniconifies any iconified
       windows as it focuses on them.  WarpFore ["name" window_name]Same
       asChangeWindowUp, but uniconifies any iconified windows as it focuses
       on them.  WindowList [arg1 arg2]Specifies the internal popup menu in
       which the titles of each open 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 if it's behind
       other windows. If the application is currently iconified, then it will
       be de-iconified normally.Generally, ifarg1is an even number, then the
       windows will be listed using the window name (the name that shows up in
       the title-bar); ifarg1is an odd number, then the window's icon name is
       used.Specifically, ifarg1is 0, 1 or 2, then all windows on all desks
       will be shown. Ifarg1is 2 or 3, then only windows on the current desk
       will be shown. Ifarg1is 4 or 5, then only windows on the desk number
       specified witharg2, will be shown. Windows which have WindowListSkip
       specified in their style will not be listed in the window list.
       WindowsDesknew_desk[10000]Moves the selected window to the desktop
       specified asnew_desk. If second argument is set to 10000 then first is
       treated as relative desktop number.






3rd Berkeley Distribution      AfterStep v.2.2.9                  Functions(1)
