tmux
/
tmux-resurrect
mirror of https://github.com/tmux-plugins/tmux-resurrect.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Update readme

This commit is contained in:
Bruno Sutic 2014-08-28 01:09:55 +02:00
parent cde50d4d92
commit 5509256a02
No known key found for this signature in database
GPG Key ID: 66D96E4F2F7EF26C
2 changed files with 23 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGELOG.md
View File

@ -6,6 +6,7 @@
- enable whitelisting processes that will be restored - enable whitelisting processes that will be restored
- expand readme with configuration options - expand readme with configuration options
- enable command strategies; enable restoring vim sessions - enable command strategies; enable restoring vim sessions
- update readme: explain restoring vim sessions
### v0.0.4, 2014-08-26 ### v0.0.4, 2014-08-26
- restore pane layout for each window - restore pane layout for each window

30
README.md
View File

@ -11,6 +11,13 @@ projects.
Enter `tmux-session-saver`: tmux persistence without configuration so there are Enter `tmux-session-saver`: tmux persistence without configuration so there are
no interruptions in your workflow. no interruptions in your workflow.
It will even (optionally) [restore vim sessions](#restoring-vim-sessions)!
### Key bindings
- `prefix + Alt-s` - save
- `prefix + Alt-r` - restore
### About ### About
This plugin goes to great lengths to save and restore all the details from your This plugin goes to great lengths to save and restore all the details from your
@ -18,19 +25,16 @@ This plugin goes to great lengths to save and restore all the details from your
- all sessions, windows, panes and their order - all sessions, windows, panes and their order
- current working directory for each pane - current working directory for each pane
- **exact panes layout** within a window - **exact pane layouts** within windows
- active and alternative session - active and alternative session
- active and alternative window for each session - active and alternative window for each session
- active pane for each window - active pane for each window
- programs running within a pane! More details in the [configuration section](#configuration). - programs running within a pane! More details in the [configuration section](#configuration).
- restoring vim sessions (optional). More details in
[restoring vim sessions](#restoring-vim-sessions).
Requirements / dependencies: `tmux 1.9` or higher, `pgrep` Requirements / dependencies: `tmux 1.9` or higher, `pgrep`
### Key bindings
- `prefix + Alt-s` - save
- `prefix + Alt-r` - restore
### Installation with [Tmux Plugin Manager](https://github.com/tmux-plugins/tpm) (recommended) ### Installation with [Tmux Plugin Manager](https://github.com/tmux-plugins/tpm) (recommended)
Add plugin to the list of TPM plugins in `.tmux.conf`: Add plugin to the list of TPM plugins in `.tmux.conf`:
@ -78,16 +82,26 @@ Open a github issue if you think some other program should be on the default lis
set -g @session-saver-processes ':all:' set -g @session-saver-processes ':all:'
#### Restoring vim sessions
- save vim sessions - I recommend [tpope/vim-obsession](tpope/vim-obsession)
- in `.tmux.conf`:
set -g @session-saver-strategy-vim "session"
`tmux-session-saver` will now restore vim sessions if `Sessions.vim` file is
present.
### Reporting bugs and contributing ### Reporting bugs and contributing
Code contributions are welcome! Code contributions are welcome!
If you find a bug please report it in the issues. When reporting a bug please If you find a bug please report it in the issues. When reporting a bug please
attach a file that is symlinked to `~/.tmux/sessions/last`. attach a file symlinked to `~/.tmux/sessions/last`.
### Credits ### Credits
[Mislav Marohnic](https://github.com/mislav) - the idea for the plugin came from his [Mislav Marohnić](https://github.com/mislav) - the idea for the plugin came from his
[tmux-session script](https://github.com/mislav/dotfiles/blob/master/bin/tmux-session). [tmux-session script](https://github.com/mislav/dotfiles/blob/master/bin/tmux-session).
### License ### License