FvwmCommand(1x)

FvwmCommand(1x)

FvwmClean Home Page User Commands Index FvwmConfig


NAME
       FvwmCommand - FVWM command external interface

SYNOPSIS
       In .fvwm2rc file:

         Module FvwmCommandS [name]

       Then, in script file or from shell:

         FvwmCommand [-mrvw] [-i level] [-f name] [command...]

DESCRIPTION
       FvwmCommand  lets  you  monitor fvwm transaction and issue
       fvwm command from a shell command line or scripts.   Fvwm-
       Command  takes each argument as a fvwm command. Quotes can
       be used to send commands including spaces.

       FvwmCommand.pm is for perl scripts in order  to  keep  the
       syntax similar to fvwm configuration file.

         use FvwmCommand;
         if( $ARGV[0] eq 'home' ) {
             Desk 0,0; GotoPage '1 1';
         }elsif( $ARGV[0] eq 'jump' ) {
             Desk "0 2"; GotoPage 1, 1;
         }

       Commas can be used to separate Fvwm commands' arguments or
       quotes can be used combine them.  The  commands  are  case
       sensitive.

       FvwmCommand.sh  is collection of functions for bourn shell
       or its cousines. It is to be sourced:

         . FvwmCommand.sh
         DesktopSize 5x5

       The commands in FvwmCommand.sh and FvwmCommand.pl are case
       sensitive.

INVOCATION
       FvwmCommandS  should  be  spawned  once by fvwm, either in

       .fvwm2rc file, from menu, or from FvwmConsole.  From  then
       on,  FvwmCommand  can  be called from a shell or script to
       execute fvwm commands.

OPTIONS
       -f <name>
           Specifies an alternative fifo set to communicate  with
           FvwmCommandS.  The default fifo set is ~/.FvwmCommand,
           in which ~/.FvwmCommandC is used to send commands  and
           ~/.FvwmCommandM  is to receive messages.  FvwmCommandS
           must have been invoked with the  same  <name>  as  its
           first  argument prior to FvwmCommand invokation.  This
           option is useful when a dedicated connection is neces-
           sary  to run a background job while another connection
           is kept for interactive use.

       -i &lt;level>
           Specified the level of  information  FvwmCommand  out-
           puts.

           0   Error messages only. Note that Fvwm doesn't return
               any error messages in cases like below since 'win-
               dowid' itself is a valid command.
                 FvwmCommand -i 0 'windowid abcd move'

           1   Errors  and window configuration information. This
               is the default.
                 FvwmCommand FvwmIconMan
               The following infomation will show up.
                 0x03400003 window               FvwmIconMan
                 0x03400003 icon                 FvwmIconMan
                 0x03400003 class                FvwmModule
                 0x03400003 resource             FvwmIconMan
               The first column shows the window ID number, which
               can  be  used  in  'windowid' command.  The second
               column shows the information types.  The last col-
               umn  shows the information contents.  If no infor-
               mation is returned, add  -w  <time>  option.  This
               might be needed in heavily loaded systems.

           2   Above and static window information.
                 FvwmCommand -i2 'FvwmIconBox'
               The below is its output.
                 0x02400002 frame                x 0, y 0, width 410, height 116
                 0x02400002 desktop              0
                 0x02400002 StartIconic          no
                 0x02400002 OnTop                no
                 0x02400002 Sticky               yes
                 0x02400002 WindowListSkip       yes
                 0x02400002 SuppressIcon         no
                 0x02400002 NoiconTitle          no
                 0x02400002 Lenience             no
                 0x02400002 StickyIcon           no
                 0x02400002 CirculateSkipIcon    no
                 0x02400002 CirculateSkip        no
                 0x02400002 ClickToFocus         no
                 0x02400002 SloppyFocus          no
                 0x02400002 SkipMapping          no
                 0x02400002 Handles              no
                 0x02400002 Title                no
                 0x02400002 Mapped               no
                 0x02400002 Iconified            no
                 0x02400002 Transient            no
                 0x02400002 Raised               no
                 0x02400002 Visible              no
                 0x02400002 IconOurs             no
                 0x02400002 PixmapOurs           no
                 0x02400002 ShapedIcon           no
                 0x02400002 Maximized            no
                 0x02400002 WmTakeFocus          no
                 0x02400002 WmDeleteWindow       yes
                 0x02400002 IconMoved            no
                 0x02400002 IconUnmapped         no
                 0x02400002 MapPending           no
                 0x02400002 HintOverride         yes
                 0x02400002 MWMButtons           no
                 0x02400002 MWMBorders           no
                 0x02400002 title height         0
                 0x02400002 border width         4
                 0x02400002 base size            width 0, height 0
                 0x02400002 size increment       width 72, height 66
                 0x02400002 min size             width 114, height 108
                 0x02400002 max size             width 32767, height 32767
                 0x02400002 gravity              NorthWest
                 0x02400002 pixel                text 0xffff, back 0x7bef
                 0x02400002 window               FvwmIconBox
                 0x02400002 icon                 FvwmIconBox
                 0x02400002 class                FvwmIconBox
                 0x02400002 resource             FvwmIconBox

           3   All information available.
                 FvwmCommand -i3 'Killmodule FvwmIcon*'
               This will report which windows are closed.
                 0x03400003 destroy
                 0x02400002 destroy

       -m  Monitors fvwm window information transaction. FvwmCom-
           mand  continuously  outputs  information  it  receives
           without  exiting.  This  is  used  in a background job
           often combined with -i3 option  in  order  to  control
           windows dynamically.

             FvwmCommand -mi3 | grep 'iconify'

           It  will report when windows are iconified or deiconi-
           fied.

           Note: FvwmCommand does not buffer its stdout but  many
           utilities  such  as grep or sed uses block buffer. The
           output of the next example  will  not  show  up  until
           either FvwmCommand is terminated or stdout buffer from
           grep is filled.

             FvwmCommand -mi3 | grep ' map' |
             sed 's/[0-9a-f]*.*/windowid 1 move 0 0/'

           Instead, use tools with buffer control such  as  perl.
           The below will iconify new windows when opened.

             Fvwm -mi3 | perl -ne '
             $|=1;
             print "windowid $1 iconify\n" if /^(0x\S+) add/;
             ' > ~/.FvwmCommandC

       -r  Waits  for a reply before it exits.  FvwmCommand exits
           if no information or error  is  returned  in  a  fixed
           amount  of  time  period.   This option overrides this
           time limit and wait for at  least  one  message  back.
           After  the  initial  message, it will wait for another
           message for the time limit.   This  option  is  useful
           when the system is too load to make any predition when
           the system is responding AND the command  causes  some
           message to be sent back.

       -v  Returns FvwmCommand version number and exits.

       -w &lt;time>
           Waits  for  <time> micro seconds for a message.  Fvwm-
           Command exits if no information or error  is  returned
           in  a  fixed amount of time period. The default is 500
           ms. This option overrides this default value.

             FvwmCommand -w 0 'killme'

ERRORS
       If the following error message show up, it is most  likely
       that FvwmCommandS is not running.

         FvwmCommand error in opening message
         --No such file or directory--

SEE ALSO
       fvwm2

AUTHOR
       Toshi Isogai  isogai@enshin.com

FvwmClean Home Page User Commands Index FvwmConfig