Changeset - d0274b1cb10e
[Not reviewed]
0 1 0
Sergey Pashinin - 11 years ago 2014-08-30 12:35:33
sergey@pashinin.com
More highlight in readme
1 file changed with 21 insertions and 18 deletions:
README.md
21
18
0 comments (0 inline, 0 general)
README.md
Show inline comments
 
@@ -9,66 +9,69 @@ Workgroups is a session manager for Emacs.
 

	
 
- It saves all your opened buffers, their location and sizes on disk to restore later
 
- You can create several workspaces
 

	
 
You can also restore such buffers as: org-agenda, shell, magit-status, help.
 

	
 
Fork it, [add more special buffers support](https://github.com/pashinin/workgroups2/wiki/How-to-restore-a-specific-type-of-buffer). Or even better - fix bugs.
 

	
 
## Install
 

	
 
Just install "workgroups2" from Melpa and activate it with
 

	
 
    (require 'workgroups2)
 
    ;; Change some settings
 
    (workgroups-mode 1)        ; put this one at the bottom of .emacs
 
```elisp
 
(require 'workgroups2)
 
;; Change some settings
 
(workgroups-mode 1)        ; put this one at the bottom of .emacs
 
```
 

	
 
## Use
 

	
 
Most commands are bound to both `<prefix> <key>` and `<prefix> C-<key>`.
 

	
 
By default prefix is: "C-c z" (To change it - see settings below)
 

	
 
    <prefix> <key>
 
    <prefix> c    - create workgroup
 
    <prefix> A    - rename workgroup
 
    <prefix> k    - kill workgroup
 
    <prefix> v    - switch to workgroup
 
    <prefix> C-s  - save session
 
    <prefix> C-f  - load session
 

	
 
## Configure
 

	
 
If you want to change some settings - here is an example:
 

	
 
    (require 'workgroups2)
 
    ;; Your settings here
 

	
 
    ;;(setq wg-session-load-on-start t)    ; default: (not (daemonp))
 
```elisp
 
(require 'workgroups2)
 
;; Your settings here
 

	
 
    ;; Change prefix key (before activating WG)
 
    (setq wg-prefix-key (kbd "C-c z"))
 
;;(setq wg-session-load-on-start t)    ; default: (not (daemonp))
 

	
 
    ;; Change workgroups session file
 
    (setq wg-session-file "~/.emacs.d/.emacs_workgroups")
 
;; Change prefix key (before activating WG)
 
(setq wg-prefix-key (kbd "C-c z"))
 

	
 
    ;; Set your own keyboard shortcuts to reload/save/switch WG:
 
    ;; "s" == "Super" or "Win"-key, "S" == Shift, "C" == Control
 
    (global-set-key (kbd "<pause>")     'wg-reload-session)
 
    (global-set-key (kbd "C-S-<pause>") 'wg-save-session)
 
    (global-set-key (kbd "s-z")         'wg-switch-to-workgroup)
 
    (global-set-key (kbd "s-/")         'wg-switch-to-previous-workgroup)
 
;; Change workgroups session file
 
(setq wg-session-file "~/.emacs.d/.emacs_workgroups")
 

	
 
    (workgroups-mode 1)   ; put this one at the bottom of .emacs
 
;; Set your own keyboard shortcuts to reload/save/switch WGs:
 
;; "s" == "Super" or "Win"-key, "S" == Shift, "C" == Control
 
(global-set-key (kbd "<pause>")     'wg-reload-session)
 
(global-set-key (kbd "C-S-<pause>") 'wg-save-session)
 
(global-set-key (kbd "s-z")         'wg-switch-to-workgroup)
 
(global-set-key (kbd "s-/")         'wg-switch-to-previous-workgroup)
 

	
 
(workgroups-mode 1)   ; put this one at the bottom of .emacs
 
```
 
## More options
 

	
 
```elisp
 
;; What to do on Emacs exit / workgroups-mode exit?
 
(setq wg-emacs-exit-save-behavior           'save)      ; Options: 'save 'ask nil
 
(setq wg-workgroups-mode-exit-save-behavior 'save)      ; Options: 'save 'ask nil
 
```
 

	
 
## Help
 

	
 
Type `<prefix> ?` (Eval `(wg-help)`) for more help.
 

	
0 comments (0 inline, 0 general)