"Fossies" - the Fresh Open Source Software Archive

Member "xbindkeys-1.8.7/README" (1 Mar 2020, 4422 Bytes) of package /linux/privat/xbindkeys-1.8.7.tar.gz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the last Fossies "Diffs" side-by-side code changes report for "README": 0.1.3_vs_1.8.6.

    1 
    2 
    3 			       Overview
    4 			       """"""""
    5 This program grab keys in X and start the corresponding shell command.
    6 
    7 			       Required
    8 			       """"""""
    9 
   10     XFree86
   11 
   12 to compile from source:
   13     
   14     The X11 include files and libraries. (Not the X server development packages)
   15 
   16 			     Installation
   17 			     """"""""""""
   18 configure --help
   19 configure (and any options you want to set)
   20 make
   21 make install
   22 
   23 			      .xbindkeysrc
   24 			      """"""""""""
   25 [ OVERVIEW ]
   26 The configuration of specific clients is taken care of in the file called 
   27 "$HOME/.xbindkeysrc"
   28 
   29 You can have a default file with the --defaults option:
   30 
   31 	xbindkeys --defaults
   32 
   33 The pound(#) symbol may be used anywhere for comments. 
   34 
   35 [ COMMAND ]
   36 A command is formated like this:
   37 
   38 "Command to start &"
   39   modifier+modifier+ key
   40 
   41 
   42 Where modifier are:
   43 
   44 	Control, Shift, Alt or Mod1, Mod2 (numlock), Mod3, Mod4, Mod5
   45 
   46 	(modifiers are not case sensitive).
   47 
   48 By defaults, xbindkeys does not pay attention with the modifiers
   49 NumLock, CapsLock and ScrollLock.
   50 Add the lines above in the config file, if you want to pay attention to them.
   51 
   52 	keystate_numlock = enable
   53 	keystate_capslock = enable
   54 	keystate_scrolllock= enable
   55 
   56 
   57 use 'xev' or 'xbindkeys --key' or 'xbindkeys --multikey' to know modifier 
   58 and keycode or keysym.
   59 
   60 Example:
   61 
   62         # control+alt+mod2 + d (it's a comment)
   63           "xterm &"
   64           control+alt+mod2 + d
   65 
   66         # control+alt+mod2 + f (it's a comment)
   67            "rxvt &"
   68            m:0x1c + c:41
   69 
   70   Here, pushing control+alt+mod2 (numlock enabled) and d starts  an xterm.
   71 And pushing control+alt+mod2 and f starts rxvt.
   72 
   73   Please, don't forget the '&' at the end of the command,
   74 if not xbindkeys will launch only one command at the same time
   75 
   76 
   77 
   78 In version 1.7.0 and later, you can use a scheme/guile style in configuration
   79 file (the default is ~/.xbindkeysrc.scm).
   80 Try xbindkeys --defaults-guile for more details.
   81 
   82 In version 1.8.0 and later, you have a full access to the xbindkeys internal  
   83 from guile scheme. This allow some more complicated configuration file and 
   84 prevent the need of a shell script (like double click, timed double click or
   85 keys combinations).
   86 See xbindkeysrc.scm or xbindkeysrc-combo.scm in the source directory for some
   87 examples.
   88 Note: The guile configuration file is the prefered way when there is a need for
   89 a non trivial configuration. (I think) there is no need to hack the xbindkeys
   90 source code. All can be done with the guile file.
   91 For more details, please see here:
   92 
   93   http://www.gnu.org/software/guile/guile.html
   94 
   95 
   96 			       Options
   97 			       """""""
   98 Use the -h or --help option for all available options.
   99 
  100 -f
  101 --file
  102                 use an alternative xbindkeysrc (defaults is $HOME/.xbindkeysrc)
  103 
  104 -h
  105 --help
  106                 help for xbindkeys.
  107 
  108 -v
  109 --verbose
  110                 Verbose mode. Print more information when
  111                 the program is running.
  112          
  113 -X <display>
  114 --display <display>
  115                 use XServer at a specified display in standard X form.
  116                 using this mode allows for multiple displays.
  117 
  118 -d
  119 --defaults
  120                 Show a default rc file. You can use it to create the file
  121                 $HOME/.xbindkeysrc like this:
  122 
  123                       'xbindkeys --defaults > $HOME/.xbindkeysrc'
  124 
  125 -k
  126 --key
  127                 Identify key pressed. This option is usefull to fill
  128                 $HOME/.xbindkeysrc. You have just to press a key to
  129                 know what to put in the config file.
  130 
  131 -mk
  132 --multikey
  133                 Identify key pressed like with --key option, but you can 
  134 		press modifier and key, and you can make multi tries.
  135 		You have just to press a key to know what to put in the 
  136 		config file.
  137 
  138 -g
  139 --geometry
  140                 Set size and position of the window open with the 
  141 		--key / --multikey options.
  142 
  143 -n
  144 --nodaemon
  145                 Don't start as daemon. By default, xbindkeys starts in
  146                 background, this option prevents this feature.
  147 
  148 If guile support have not been disabled:
  149 
  150 -dg
  151 --defaults-guile
  152                 Print a default guile configuration file
  153 
  154 -fg
  155 --file-guile
  156                 Use an alternative guile configuration file
  157 
  158 
  159 
  160 				Usage
  161 				"""""
  162 xbindkeys &
  163 
  164 if you want, you can start it with X:
  165 
  166     Edit your .xsession or .XClients or .xinitrc (if any) and 
  167     add a line like this:
  168 
  169          xbindkeys
  170 
  171 
  172 
  173 			     Contact Info
  174 			     """"""" """"
  175 			  Philippe Brochard
  176 			    <hocwp@free.fr>
  177 			 http://hocwp.free.fr