Note: this file is auto converted from exwm-x.el by el2org, please do not edit it by hand!!!
EXWM-X is a derivative window manager based on EXWM (emacs x window manager), which focus on Mouse-Control-People.
Tilling windows
Floating windows
`exwmx-appconfig' is a database manager, which is used to record and manage appconfigs (an appconfig is a plist of application's information), when run command `exwmx-appconfig', a buffer with appconfig-template will be poped up, user can edit the template and run `exwmx-appconfig-finish' to save the change or run `exwmx-appconfig-ignore' to ignore the change.
All appconfigs will be saved into file: `exwmx-appconfig-file'.
By default, every appconfig have the following keys:
:command
Record the shell command of application.
:alias
Define alias of an application, this key is used by `exwmx-quickrun'.
:pretty-name
In EXWM and EXWM-X, an application is assocated with an emacs buffer, user can set the buffer's name with :pretty-name.
:paste-key
Record the paste keybinding of an application, this key is used by `exwmx-sendstring'.
:class
Record the application's class, this key is used by `exwmx-quickrun'.
:instance
Record the application's instance, this key is used by `exwmx-quickrun'.
:title
Record the application's title, this key is used by `exwmx-quickrun'.
:floating
If set it to `t', application will floating when launched.
:size-and-position
If set :floating to `t', user can use this key to set the floating window's size and position.
Its value is a list of four elements:
(width height x-pos y-pos)
:add-prefix-keys
Add a key to `exwm-input-prefix-keys' of application.
:remove-prefix-keys
Remove a key from `exwm-input-prefix-keys' of application,
Note: if set it to `t', all keys in `exwm-input-prefix-keys' will be removed, this is very useful when you want to launch a new emacs session, this make new emacs session use nearly all the keybindings except the keybindings defined by `exwmx-input-set-key'.
:ignore-simulation-keys
Ingore simulation keys of application, if you set :remove-prefix-keys to 't, maybe you should set this option to 't too.
:eval
Evaluation a expression when launch an application.
EXWM-X add the following buttons to mode-line, user can click them to operate application's window:
Note: user can use mode-line as the button-line of floating window:
(setq exwmx-button-floating-button-line 'mode-line)
By default, EXWM use "s-'down-mouse-1'" to move a floating-window and "s-'down-mouse-3'" to resize a floating-window.
When EXWM-X is enabled, user can drag title showed in button-line to move a floating-window. and click [9][8][7][6][5] in button-line to set a floating-window's size, without press WIN key.
Note: button-line is mode-line or header-line of emacs.
If the application's window is found, jump to this window, otherwise, launch the application with command.
Common usage
(exwmx-quickrun "firefox")
Note: `exwmx-quickrun' need appconfigs stored in `exwmx-appconfig-file', user should store appconfigs of frequently used applications by yourself with the help of `exwmx-appconfig'.
Define an alias
Search an appconfig which :alias is "web-browser", and run this appconfig's :command.
(exwmx-quickrun "web-browser" t)
Adjust window ruler
(exwmx-quickrun "firefox" nil '(:class :instance :title))
or
(exwmx-quickrun "firefox" nil '(:class "XXX" :instance "XXX" :title "XXX"))
`exwmx-dmenu' let user input or select a command in minibuffer, and execute it.
`exwmx-dmenu' support some command prefixes:
",command": run "command" in terminal emulator, for example, ",top" will execute a terminal emulator, then run shell command: "top" .
Note: user can change terminal emulator by variable `exwmx-terminal-emulator'.
";command": run an emacs command which name is exwmx:"command".
"-Num1Num2": split window top-to-bottom, for example, the result of command "-32" is: 3 windows on top and 2 windows in buttom.
"|Num1Num2": split window left-to-right, for example, the result of command "|32" is: 3 windows at left and 2 window at right.
User can customize the prefixes of `exwmx-dmenu' with the help of `exwmx-dmenu-prefix-setting'.
`exwmx-sendstring' let user send a string to application, it is a simple tool but very useful, for example:
when run `exwmx-sendstring', a buffer will be poped up to let user edit. after run command `exwmx-sendstring-finish', the content of the buffer will be sent to the input field of current application.
`exwmx-sendstring-from-minibuffer' is a simple version of `exwmx-sendstring', it use minibuffer to get input.
`exwmx-sendstring–send' can send a string to application, it is used by elisp.
NOTE: if `exwmx-sendstring' can not work well with an application, user should set :paste-key of this application with the help of `exwmx-appconfig'.
Pasting the below line to "~/.emacs" is a simple way.
(add-to-list 'load-path "/path/to/exwm-x")
You should edit "~/.initrc" file, "~/.xsession" file or "~/.xsessionrc" file like below example:
# Support exwm-xim.
# export XMODIFIERS=@im=exwm-xim
# export GTK_IM_MODULE=xim
# export QT_IM_MODULE=xim
# export CLUTTER_IM_MODULE=xim
# Fallback cursor
# xsetroot -cursor_name left_ptr
# Keyboard repeat rate
# xset r rate 200 60
xhost +SI:localuser:$USER
exec dbus-launch --exit-with-session emacs --eval '(require (quote exwmx-loader))'
chmod a+x ~/.xsession
or
chmod a+x ~/.initrc
Add your exwm config to this file, for example:
(require 'exwm)
(require 'exwm-x)
(require 'exwmx-xfce)
(require 'exwmx-example)
(exwmx-input-set-key (kbd "C-t v") 'exwmx:file-browser)
(exwmx-input-set-key (kbd "C-t f") 'exwmx:web-browser)
(exwmx-input-set-key (kbd "C-t e") 'exwmx:emacs)
(exwmx-input-set-key (kbd "C-t c") 'exwmx-xfce-terminal)
(exwmx-input-set-key (kbd "C-t z") 'exwmx-floating-hide-all)
(exwmx-input-set-key (kbd "C-t C-c") 'exwmx-xfce-new-terminal)
(exwmx-input-set-key (kbd "C-t b") 'exwmx-switch-application)
(exwmx-input-set-key (kbd "C-t C-f") 'exwmx-floating-toggle-floating)
When user first login in EXWM-X desktop environment, appconfigs of frequently used applications should be added to appconfig database file: `exwmx-appconfig-file', it is simple but very very important, for many useful commands of EXWM-X need this database file, for example: `exwmx-quickrun', `exwmx-sendstring' and so on.
user should do like the below:
"exwmx-example" is EXWM-X buildin example, user can use it to test EXWM-X's features, the following is its keybindings. by the way, EXWM-X is a EXWM derivative, most EXWM commands can be used too :-)
Key | command |
---|---|
"C-t ;" | exwmx-dmenu |
"C-t C-e" | exwmx-sendstring |
"C-t C-r" | exwmx-appconfig |
"C-t 1" | exwmx-switch-to-1-workspace |
"C-t 2" | exwmx-switch-to-2-workspace |
"C-t 3" | exwmx-switch-to-3-workspace |
"C-t 4" | exwmx-switch-to-4-workspace |
"C-x o" | switch-window |
"C-c y" | exwmx-sendstring-from-kill-ring |
If exwmx-example doesn't suit for your need, just copy and paste its useful pieces to your "~/.exwm-x" file.
If user want to full override exwmx-example, a simple way is setting like the below line before load exwmx-loader.
(defvar exwmx-default-example)
(setq exwmx-default-example 'your-own-example)