Compare commits
No commits in common. "master" and "v1.5.0" have entirely different histories.
|
|
@ -1,5 +0,0 @@
|
|||
# Force text files to have unix eols, so Windows/Cygwin does not break them
|
||||
*.* eol=lf
|
||||
|
||||
# Except for images because then on checkout the files have been altered.
|
||||
*.png binary
|
||||
|
|
@ -1,3 +0,0 @@
|
|||
run_tests
|
||||
tests/run_tests_in_isolation
|
||||
tests/helpers/helpers.sh
|
||||
|
|
@ -1,3 +0,0 @@
|
|||
[submodule "lib/tmux-test"]
|
||||
path = lib/tmux-test
|
||||
url = https://github.com/tmux-plugins/tmux-test.git
|
||||
19
.travis.yml
19
.travis.yml
|
|
@ -1,19 +0,0 @@
|
|||
# generic packages and tmux
|
||||
before_install:
|
||||
- sudo apt-get update
|
||||
- sudo apt-get install -y git-core expect
|
||||
- sudo apt-get install -y python-software-properties software-properties-common
|
||||
- sudo apt-get install -y libevent-dev libncurses-dev
|
||||
- git clone https://github.com/tmux/tmux.git
|
||||
- cd tmux
|
||||
- git checkout 2.5
|
||||
- sh autogen.sh
|
||||
- ./configure && make && sudo make install
|
||||
|
||||
install:
|
||||
- git fetch --unshallow --recurse-submodules || git fetch --recurse-submodules
|
||||
# manual `git clone` required for testing `tmux-test` plugin itself
|
||||
- git clone https://github.com/tmux-plugins/tmux-test lib/tmux-test; true
|
||||
- lib/tmux-test/setup
|
||||
|
||||
script: ./tests/run_tests_in_isolation
|
||||
71
CHANGELOG.md
71
CHANGELOG.md
|
|
@ -1,77 +1,6 @@
|
|||
# Changelog
|
||||
|
||||
### master
|
||||
- Remove deprecated "restoring shell history" feature.
|
||||
|
||||
### v4.0.0, 2022-04-10
|
||||
- Proper handling of `automatic-rename` window option.
|
||||
- save and restore tmux pane title (breaking change: you have to re-save to be
|
||||
able to properly restore!)
|
||||
|
||||
### v3.0.0, 2021-08-30
|
||||
- save and restore tmux pane contents (@laomaiweng)
|
||||
- update tmux-test to solve issue with recursing git submodules in that project
|
||||
- set options quietly in `resurrect.tmux` script
|
||||
- improve pane contents restoration: `cat <file>` is no longer shown in pane
|
||||
content history
|
||||
- refactoring: drop dependency on `paste` command
|
||||
- bugfix for pane contents restoration
|
||||
- expand tilde char `~` if used with `@resurrect-dir`
|
||||
- do not save empty trailing lines when pane content is saved
|
||||
- do not save pane contents if pane is empty (only for 'save pane contents'
|
||||
feature)
|
||||
- "save pane contents" feature saves files to a separate directory
|
||||
- archive and compress pane contents file
|
||||
- make archive & compress pane contents process more portable
|
||||
- `mutt` added to the list of automatically restored programs
|
||||
- added guide for migrating from tmuxinator
|
||||
- fixed a bug for restoring commands on tmux 2.5 (and probably tmux 2.4)
|
||||
- do not create another resurrect file if there are no changes (credit @vburdo)
|
||||
- allow using '$HOSTNAME' in @resurrect-dir
|
||||
- add zsh history saving and restoring
|
||||
- delete resurrect files older than 30 days, but keep at least 5 files
|
||||
- add save and restore hooks
|
||||
- always use `-ao` flags for `ps` command to detect commands
|
||||
- Deprecate restoring shell history feature.
|
||||
- `view` added to the list of automatically restored programs
|
||||
- Enable vim session strategy to work with custom session files,
|
||||
e.g. `vim -S Session1.vim`.
|
||||
- Enable restoring command arguments for inline strategies with `*` character.
|
||||
- Kill session "0" if it wasn't restored.
|
||||
- Add `@resurrect-delete-backup-after` option to specify how many days of
|
||||
backups to keep - default is 30.
|
||||
|
||||
### v2.4.0, 2015-02-23
|
||||
- add "tmux-test"
|
||||
- add test for "resurrect save" feature
|
||||
- add test for "resurrect restore" feature
|
||||
- make the tests work and pass on travis
|
||||
- add travis badge to the readme
|
||||
|
||||
### v2.3.0, 2015-02-12
|
||||
- Improve fetching proper window_layout for zoomed windows. In order to fetch
|
||||
proper value, window has to get unzoomed. This is now done faster so that
|
||||
"unzoom,fetch value,zoom" cycle is almost unnoticable to the user.
|
||||
|
||||
### v2.2.0, 2015-02-12
|
||||
- bugfix: zoomed windows related regression
|
||||
- export save and restore script paths so that 'tmux-resurrect-save' plugin can
|
||||
use them
|
||||
- enable "quiet" saving (used by 'tmux-resurrect-save' plugin)
|
||||
|
||||
### v2.1.0, 2015-02-12
|
||||
- if restore is started when there's only **1 pane in the whole tmux server**,
|
||||
assume the users wants the "full restore" and overrwrite that pane.
|
||||
|
||||
### v2.0.0, 2015-02-10
|
||||
- add link to the wiki page for "first pane/window issue" to the README as well
|
||||
as other tweaks
|
||||
- save and restore grouped sessions (used with multi-monitor workflow)
|
||||
- save and restore active and alternate windows in grouped sessions
|
||||
- if there are no grouped sessions, do not output empty line to "last" file
|
||||
- restore active and alternate windows only if they are present in the "last" file
|
||||
- refactoring: prefer using variable with tab character
|
||||
- remove deprecated `M-s` and `M-r` key bindings (breaking change)
|
||||
|
||||
### v1.5.0, 2014-11-09
|
||||
- add support for restoring neovim sessions
|
||||
|
|
|
|||
134
README.md
134
README.md
|
|
@ -1,8 +1,6 @@
|
|||
# Tmux Resurrect
|
||||
|
||||
[](https://travis-ci.org/tmux-plugins/tmux-resurrect)
|
||||
|
||||
Restore `tmux` environment after system restart.
|
||||
Restore `tmux` environment after a system restart.
|
||||
|
||||
Tmux is great, except when you have to restart the computer. You lose all the
|
||||
running programs, working directories, pane layouts etc.
|
||||
|
|
@ -14,11 +12,7 @@ projects.
|
|||
can be completely restored after a system restart (or when you feel like it).
|
||||
No configuration is required. You should feel like you never quit tmux.
|
||||
|
||||
It even (optionally)
|
||||
[restores vim and neovim sessions](docs/restoring_vim_and_neovim_sessions.md)!
|
||||
|
||||
Automatic restoring and continuous saving of tmux env is also possible with
|
||||
[tmux-continuum](https://github.com/tmux-plugins/tmux-continuum) plugin.
|
||||
It even (optionally) [restores vim and neovim sessions](#restoring-vim-and-neovim-sessions)!
|
||||
|
||||
### Screencast
|
||||
|
||||
|
|
@ -29,6 +23,13 @@ Automatic restoring and continuous saving of tmux env is also possible with
|
|||
- `prefix + Ctrl-s` - save
|
||||
- `prefix + Ctrl-r` - restore
|
||||
|
||||
`prefix + Alt-s` and `prefix + Alt-r` key bindings are now deprecated.
|
||||
|
||||
For custom key bindings, add to `.tmux.conf`:
|
||||
|
||||
set -g @resurrect-save 'S'
|
||||
set -g @resurrect-restore 'R'
|
||||
|
||||
### About
|
||||
|
||||
This plugin goes to great lengths to save and restore all the details from your
|
||||
|
|
@ -41,31 +42,26 @@ This plugin goes to great lengths to save and restore all the details from your
|
|||
- active and alternative window for each session
|
||||
- windows with focus
|
||||
- active pane for each window
|
||||
- "grouped sessions" (useful feature when using tmux with multiple monitors)
|
||||
- programs running within a pane! More details in the
|
||||
[restoring programs doc](docs/restoring_programs.md).
|
||||
|
||||
Optional:
|
||||
|
||||
- [restoring vim and neovim sessions](docs/restoring_vim_and_neovim_sessions.md)
|
||||
- [restoring pane contents](docs/restoring_pane_contents.md)
|
||||
- [restoring a previously saved environment](docs/restoring_previously_saved_environment.md)
|
||||
[configuration section](#configuration).
|
||||
- restoring vim/neovim sessions (optional). More details in
|
||||
[restoring vim and neovim sessions](#restoring-vim-and-neovim-sessions).
|
||||
- restoring bash history (optional, *experimental*). More details in
|
||||
[restoring bash history](#restoring-bash-history-experimental).
|
||||
|
||||
Requirements / dependencies: `tmux 1.9` or higher, `bash`.
|
||||
|
||||
Tested and working on Linux, OSX and Cygwin.
|
||||
|
||||
`tmux-resurrect` is idempotent! It will not try to restore panes or windows that
|
||||
already exist.<br/>
|
||||
The single exception to this is when tmux is started with only 1 pane in order
|
||||
to restore previous tmux env. Only in this case will this single pane be
|
||||
overwritten.
|
||||
already exist.
|
||||
|
||||
### Installation with [Tmux Plugin Manager](https://github.com/tmux-plugins/tpm) (recommended)
|
||||
|
||||
Add plugin to the list of TPM plugins in `.tmux.conf`:
|
||||
|
||||
set -g @plugin 'tmux-plugins/tmux-resurrect'
|
||||
set -g @tpm_plugins ' \
|
||||
tmux-plugins/tpm \
|
||||
tmux-plugins/tmux-resurrect \
|
||||
'
|
||||
|
||||
Hit `prefix + I` to fetch the plugin and source it. You should now be able to
|
||||
use the plugin.
|
||||
|
|
@ -80,29 +76,78 @@ Add this line to the bottom of `.tmux.conf`:
|
|||
|
||||
run-shell ~/clone/path/resurrect.tmux
|
||||
|
||||
Reload TMUX environment with: `$ tmux source-file ~/.tmux.conf`.
|
||||
Reload TMUX environment:
|
||||
|
||||
# type this in terminal
|
||||
$ tmux source-file ~/.tmux.conf
|
||||
|
||||
You should now be able to use the plugin.
|
||||
|
||||
### Docs
|
||||
### Configuration
|
||||
|
||||
- [Guide for migrating from tmuxinator](docs/migrating_from_tmuxinator.md)
|
||||
Configuration is not required, but it enables extra features.
|
||||
|
||||
**Configuration**
|
||||
Only a conservative list of programs is restored by default:<br/>
|
||||
`vi vim nvim emacs man less more tail top htop irssi`.
|
||||
|
||||
- [Changing the default key bindings](docs/custom_key_bindings.md).
|
||||
- [Setting up hooks on save & restore](docs/hooks.md).
|
||||
- Only a conservative list of programs is restored by default:<br/>
|
||||
`vi vim nvim emacs man less more tail top htop irssi weechat mutt`.<br/>
|
||||
[Restoring programs doc](docs/restoring_programs.md) explains how to restore
|
||||
additional programs.
|
||||
- [Change a directory](docs/save_dir.md) where `tmux-resurrect` saves tmux
|
||||
environment.
|
||||
- Restore additional programs with the setting in `.tmux.conf`:
|
||||
|
||||
**Optional features**
|
||||
set -g @resurrect-processes 'ssh psql mysql sqlite3'
|
||||
|
||||
- [Restoring vim and neovim sessions](docs/restoring_vim_and_neovim_sessions.md)
|
||||
is nice if you're a vim/neovim user.
|
||||
- [Restoring pane contents](docs/restoring_pane_contents.md) feature.
|
||||
- Programs with arguments should be double quoted:
|
||||
|
||||
set -g @resurrect-processes 'some_program "git log"'
|
||||
|
||||
- Start with tilde to restore a program whose process contains target name:
|
||||
|
||||
set -g @resurrect-processes 'irb pry "~rails server" "~rails console"'
|
||||
|
||||
- Use `->` to specify a command to be used when restoring a program (useful if
|
||||
the default restore command fails ):
|
||||
|
||||
set -g @resurrect-processes 'some_program "grunt->grunt development"'
|
||||
|
||||
- Don't restore any programs:
|
||||
|
||||
set -g @resurrect-processes 'false'
|
||||
|
||||
- Restore **all** programs (be careful with this!):
|
||||
|
||||
set -g @resurrect-processes ':all:'
|
||||
|
||||
#### Restoring vim and neovim sessions
|
||||
|
||||
- save vim/neovim sessions. I recommend
|
||||
[tpope/vim-obsession](https://github.com/tpope/vim-obsession) (as almost every
|
||||
plugin, it works for both vim and neovim).
|
||||
- in `.tmux.conf`:
|
||||
|
||||
# for vim
|
||||
set -g @resurrect-strategy-vim 'session'
|
||||
# for neovim
|
||||
set -g @resurrect-strategy-nvim 'session'
|
||||
|
||||
`tmux-resurrect` will now restore vim and neovim sessions if `Sessions.vim` file
|
||||
is present.
|
||||
|
||||
#### Resurrect save dir
|
||||
|
||||
By default Tmux environment is saved to a file in `~/.tmux/resurrect` dir.
|
||||
Change this with:
|
||||
|
||||
set -g @resurrect-dir '/some/path'
|
||||
|
||||
#### Restoring bash history (experimental)
|
||||
|
||||
In `.tmux.conf`:
|
||||
|
||||
set -g @resurrect-save-bash-history 'on'
|
||||
|
||||
Bash `history` for individual panes will now be saved and restored. Due to
|
||||
technical limitations, this only works for panes which have no program running in
|
||||
foreground when saving. `tmux-resurrect` will send history write command
|
||||
to each such pane. To prevent these commands from being added to history themselves,
|
||||
add `HISTCONTROL=ignoreboth` to your `.bashrc` (this is set by default in Ubuntu).
|
||||
|
||||
### Other goodies
|
||||
|
||||
|
|
@ -112,8 +157,6 @@ You should now be able to use the plugin.
|
|||
highlighted text to system clipboard
|
||||
- [tmux-open](https://github.com/tmux-plugins/tmux-open) - a plugin for quickly
|
||||
opening highlighted file or a url
|
||||
- [tmux-continuum](https://github.com/tmux-plugins/tmux-continuum) - automatic
|
||||
restoring and continuous saving of tmux env
|
||||
|
||||
### Reporting bugs and contributing
|
||||
|
||||
|
|
@ -123,7 +166,14 @@ Both contributing and bug reports are welcome. Please check out
|
|||
### Credits
|
||||
|
||||
[Mislav Marohnić](https://github.com/mislav) - the idea for the plugin came from his
|
||||
[tmux-session script](https://github.com/mislav/dotfiles/blob/2036b5e03fb430bbcbc340689d63328abaa28876/bin/tmux-session).
|
||||
[tmux-session script](https://github.com/mislav/dotfiles/blob/master/bin/tmux-session).
|
||||
|
||||
### Other
|
||||
|
||||
Here's another script that tries to solve the same problem:
|
||||
[link](http://brainscraps.wikia.com/wiki/Resurrecting_tmux_Sessions_After_Reboot).
|
||||
It even has the same name, even though I discovered it only after publishing
|
||||
`v1.0` of this plugin.
|
||||
|
||||
### License
|
||||
[MIT](LICENSE.md)
|
||||
|
|
|
|||
|
|
@ -1,11 +0,0 @@
|
|||
# Custom key bindings
|
||||
|
||||
The default key bindings are:
|
||||
|
||||
- `prefix + Ctrl-s` - save
|
||||
- `prefix + Ctrl-r` - restore
|
||||
|
||||
To change these, add to `.tmux.conf`:
|
||||
|
||||
set -g @resurrect-save 'S'
|
||||
set -g @resurrect-restore 'R'
|
||||
|
|
@ -1,33 +0,0 @@
|
|||
# Save & Restore Hooks
|
||||
|
||||
Hooks allow to set custom commands that will be executed during session save
|
||||
and restore. Most hooks are called with zero arguments, unless explicitly
|
||||
stated otherwise.
|
||||
|
||||
Currently the following hooks are supported:
|
||||
|
||||
- `@resurrect-hook-post-save-layout`
|
||||
|
||||
Called after all sessions, panes and windows have been saved.
|
||||
|
||||
Passed single argument of the state file.
|
||||
|
||||
- `@resurrect-hook-post-save-all`
|
||||
|
||||
Called at end of save process right before the spinner is turned off.
|
||||
|
||||
- `@resurrect-hook-pre-restore-all`
|
||||
|
||||
Called before any tmux state is altered.
|
||||
|
||||
- `@resurrect-hook-pre-restore-pane-processes`
|
||||
|
||||
Called before running processes are restored.
|
||||
|
||||
### Examples
|
||||
|
||||
Here is an example how to save and restore window geometry for most terminals in X11.
|
||||
Add this to `.tmux.conf`:
|
||||
|
||||
set -g @resurrect-hook-post-save-all 'eval $(xdotool getwindowgeometry --shell $WINDOWID); echo 0,$X,$Y,$WIDTH,$HEIGHT > $HOME/.tmux/resurrect/geometry'
|
||||
set -g @resurrect-hook-pre-restore-all 'wmctrl -i -r $WINDOWID -e $(cat $HOME/.tmux/resurrect/geometry)'
|
||||
|
|
@ -1,72 +0,0 @@
|
|||
# Migrating from `tmuxinator`
|
||||
|
||||
### Why migrate to `tmux-resurrect`?
|
||||
|
||||
Here are some reasons why you'd want to migrate from `tmuxinator` to
|
||||
`tmux-resurrect`:
|
||||
|
||||
- **Less dependencies**<br/>
|
||||
`tmuxinator` depends on `ruby` which can be a hassle to set up if you're not a
|
||||
rubyist.<br/>
|
||||
`tmux-resurrect` depends just on `bash` which is virtually
|
||||
omnipresent.
|
||||
|
||||
- **Simplicity**<br/>
|
||||
`tmuxinator` has an executable, CLI interface with half dozen commands and
|
||||
command completion.<br/>
|
||||
`tmux-resurrect` defines just 2 tmux key bindings.
|
||||
|
||||
- **No configuration**<br/>
|
||||
`tmuxinator` is all about config files (and their constant updating).<br/>
|
||||
`tmux-resurrect` requires no configuration to work.
|
||||
|
||||
- **Better change handling**<br/>
|
||||
When you make a change to any aspect of tmux layout, you also have to
|
||||
update related `tmuxinator` project file (and test to make sure change is
|
||||
ok).<br/>
|
||||
With `tmux-resurrect` there's nothing to do: your change will be
|
||||
remembered on the next save.
|
||||
|
||||
### How to migrate?
|
||||
|
||||
1. Install `tmux-resurrect`.
|
||||
2. Open \*all* existing `tmuxinator` projects.<br/>
|
||||
Verify all projects are open by pressing `prefix + s` and checking they are
|
||||
all on the list.
|
||||
3. Perform a `tmux-resurrect` save.
|
||||
|
||||
That's it! You can continue using just `tmux-resurrect` should you choose so.
|
||||
|
||||
Note: it probably makes no sense to use both tools at the same time as they do
|
||||
the same thing (creating tmux environment for you to work in).
|
||||
Technically however, there should be no issues.
|
||||
|
||||
### Usage differences
|
||||
|
||||
`tmuxinator` focuses on managing individual tmux sessions (projects).
|
||||
`tmux-resurrect` keeps track of the \*whole* tmux environment: all sessions are
|
||||
saved and restored together.
|
||||
|
||||
A couple tips if you decide to switch to `tmux-resurrect`:
|
||||
|
||||
- Keep all tmux sessions (projects) running all the time.<br/>
|
||||
If you want to work on an existing project, you should be able to just
|
||||
\*switch* to an already open session using `prefix + s`.<br/>
|
||||
This is different from `tmuxinator` where you'd usually run `mux new [project]`
|
||||
in order to start working on something.
|
||||
|
||||
- No need to kill sessions with `tmux kill-session` (unless you really don't
|
||||
want to work on it ever).<br/>
|
||||
It's the recurring theme by now: just keep all the sessions running all the
|
||||
time. This is convenient and also cheap in terms of resources.
|
||||
|
||||
- The only 2 situations when you need `tmux-resurrect`:<br/>
|
||||
1) Save tmux environment just before restarting/shutting down your
|
||||
computer.<br/>
|
||||
2) Restore tmux env after you turn the computer on.
|
||||
|
||||
### Other questions?
|
||||
|
||||
Still have questions? Feel free to open an
|
||||
[issue](ihttps://github.com/tmux-plugins/tmux-resurrect/issues). We'll try to
|
||||
answer it and also update this doc.
|
||||
|
|
@ -1,39 +0,0 @@
|
|||
tmux-ressurect no longer restores shell history for each pane, as of [this PR](https://github.com/tmux-plugins/tmux-resurrect/pull/308).
|
||||
|
||||
As a workaround, you can use the `HISTFILE` environment variable to preserve history for each pane separately, and modify
|
||||
`PROMPT_COMMAND` to make sure history gets saved with each new command.
|
||||
|
||||
Unfortunately, we haven't found a perfect way of getting a unique identifier for each pane, as the `TMUX_PANE` variable
|
||||
seems to occasionally change when resurrecting. As a workaround, the example below sets a unique ID in each pane's `title`.
|
||||
The downside of this implementation is that pane titles must all be unique across sessions/windows, and also must use the `pane_id_prefix`.
|
||||
|
||||
Any improvements/suggestions for getting a unique, persistent ID for each pane are welcome!
|
||||
|
||||
```bash
|
||||
pane_id_prefix="resurrect_"
|
||||
|
||||
# Create history directory if it doesn't exist
|
||||
HISTS_DIR=$HOME/.bash_history.d
|
||||
mkdir -p "${HISTS_DIR}"
|
||||
|
||||
if [ -n "${TMUX_PANE}" ]; then
|
||||
|
||||
# Check if we've already set this pane title
|
||||
pane_id=$(tmux display -pt "${TMUX_PANE:?}" "#{pane_title}")
|
||||
if [[ $pane_id != "$pane_id_prefix"* ]]; then
|
||||
|
||||
# if not, set it to a random ID
|
||||
random_id=$(head /dev/urandom | tr -dc A-Za-z0-9 | head -c 16)
|
||||
printf "\033]2;$pane_id_prefix$random_id\033\\"
|
||||
pane_id=$(tmux display -pt "${TMUX_PANE:?}" "#{pane_title}")
|
||||
fi
|
||||
|
||||
# use the pane's random ID for the HISTFILE
|
||||
export HISTFILE="${HISTS_DIR}/bash_history_tmux_${pane_id}"
|
||||
else
|
||||
export HISTFILE="${HISTS_DIR}/bash_history_no_tmux"
|
||||
fi
|
||||
|
||||
# Stash the new history each time a command runs.
|
||||
export PROMPT_COMMAND="$PROMPT_COMMAND;history -a"
|
||||
```
|
||||
|
|
@ -1,31 +0,0 @@
|
|||
# Restoring pane contents
|
||||
|
||||
This plugin enables saving and restoring tmux pane contents.
|
||||
|
||||
This feature can be enabled by adding this line to `.tmux.conf`:
|
||||
|
||||
set -g @resurrect-capture-pane-contents 'on'
|
||||
|
||||
##### Known issue
|
||||
|
||||
When using this feature, please check the value of `default-command`
|
||||
tmux option. That can be done with `$ tmux show -g default-command`.
|
||||
|
||||
The value should NOT contain `&&` or `||` operators. If it does, simplify the
|
||||
option so those operators are removed.
|
||||
|
||||
Example:
|
||||
|
||||
- this will cause issues (notice the `&&` and `||` operators):
|
||||
|
||||
set -g default-command "which reattach-to-user-namespace > /dev/null && reattach-to-user-namespace -l $SHELL || $SHELL -l"
|
||||
|
||||
- this is ok:
|
||||
|
||||
set -g default-command "reattach-to-user-namespace -l $SHELL"
|
||||
|
||||
Related [bug](https://github.com/tmux-plugins/tmux-resurrect/issues/98).
|
||||
|
||||
Alternatively, you can let
|
||||
[tmux-sensible](https://github.com/tmux-plugins/tmux-sensible)
|
||||
handle this option in a cross-platform way and you'll have no problems.
|
||||
|
|
@ -1,14 +0,0 @@
|
|||
# Restoring previously saved environment
|
||||
|
||||
None of the previous saves are deleted (unless you explicitly do that). All save
|
||||
files are kept in `~/.tmux/resurrect/` directory, or `~/.local/share/tmux/resurrect`
|
||||
(unless `${XDG_DATA_HOME}` says otherwise).<br/>
|
||||
Here are the steps to restore to a previous point in time:
|
||||
|
||||
- make sure you start this with a "fresh" tmux instance
|
||||
- `$ cd ~/.tmux/resurrect/`
|
||||
- locate the save file you'd like to use for restore (file names have a timestamp)
|
||||
- symlink the `last` file to the desired save file: `$ ln -sf <file_name> last`
|
||||
- do a restore with `tmux-resurrect` key: `prefix + Ctrl-r`
|
||||
|
||||
You should now be restored to the time when `<file_name>` save happened.
|
||||
|
|
@ -1,205 +0,0 @@
|
|||
# Restoring programs
|
||||
- [General instructions](#general-instructions)
|
||||
- [Clarifications](#clarifications)
|
||||
- [Working with NodeJS](#nodejs)
|
||||
- [Restoring Mosh](#mosh)
|
||||
|
||||
### General instructions <a name="general-instructions"></a>
|
||||
Only a conservative list of programs is restored by default:<br/>
|
||||
`vi vim nvim emacs man less more tail top htop irssi weechat mutt`.
|
||||
|
||||
This can be configured with `@resurrect-processes` option in `.tmux.conf`. It
|
||||
contains space-separated list of additional programs to restore.
|
||||
|
||||
- Example restoring additional programs:
|
||||
|
||||
set -g @resurrect-processes 'ssh psql mysql sqlite3'
|
||||
|
||||
- Programs with arguments should be double quoted:
|
||||
|
||||
set -g @resurrect-processes 'some_program "git log"'
|
||||
|
||||
- Start with tilde to restore a program whose process contains target name:
|
||||
|
||||
set -g @resurrect-processes 'irb pry "~rails server" "~rails console"'
|
||||
|
||||
- Use `->` to specify a command to be used when restoring a program (useful if
|
||||
the default restore command fails ):
|
||||
|
||||
set -g @resurrect-processes 'some_program "grunt->grunt development"'
|
||||
|
||||
- Use `*` to expand the arguments from the saved command when restoring:
|
||||
|
||||
set -g @resurrect-processes 'some_program "~rails server->rails server *"'
|
||||
|
||||
- Don't restore any programs:
|
||||
|
||||
set -g @resurrect-processes 'false'
|
||||
|
||||
- Restore **all** programs (dangerous!):
|
||||
|
||||
set -g @resurrect-processes ':all:'
|
||||
|
||||
Be *very careful* with this: tmux-resurrect can not know which programs take
|
||||
which context, and a `sudo mkfs.vfat /dev/sdb` that was just formatting an
|
||||
external USB stick could wipe your backup hard disk if that's what's attached
|
||||
after rebooting.
|
||||
|
||||
This option is primarily useful for experimentation (e.g., to find out which
|
||||
program is recognized in a pane).
|
||||
|
||||
### Clarifications <a name="clarfications"></a>
|
||||
|
||||
> I don't understand tilde `~`, what is it and why is it used when restoring
|
||||
programs?
|
||||
|
||||
Let's say you use `rails server` command often. You want `tmux-resurrect` to
|
||||
save and restore it automatically. You might try adding `rails server` to the
|
||||
list of programs that will be restored:
|
||||
|
||||
set -g @resurrect-processes '"rails server"' # will NOT work
|
||||
|
||||
Upon save, `rails server` command will actually be saved as this command:
|
||||
`/Users/user/.rbenv/versions/2.0.0-p481/bin/ruby script/rails server`
|
||||
(if you wanna see how is any command saved, check it yourself in
|
||||
`~/.tmux/resurrect/last` file).
|
||||
|
||||
When programs are restored, the `rails server` command will NOT be restored
|
||||
because it does not **strictly** match the long
|
||||
`/Users/user/.rbenv/versions/2.0.0-p481/bin/ruby script/rails server` string.
|
||||
|
||||
The tilde `~` at the start of the string relaxes process name matching.
|
||||
|
||||
set -g @resurrect-processes '"~rails server"' # OK
|
||||
|
||||
The above option says: "restore full process if `rails server` string is found
|
||||
ANYWHERE in the process name".
|
||||
|
||||
If you check long process string, there is in fact a `rails server` string at
|
||||
the end, so now the process will be successfully restored.
|
||||
|
||||
> What is arrow `->` and why is is used?
|
||||
|
||||
(Please read the above clarification about tilde `~`).
|
||||
|
||||
Continuing with our `rails server` example, when the process is finally restored
|
||||
correctly it might not look pretty as you'll see the whole
|
||||
`/Users/user/.rbenv/versions/2.0.0-p481/bin/ruby script/rails server` string in
|
||||
the command line.
|
||||
|
||||
Naturally, you'd rather want to see just `rails server` (what you initially
|
||||
typed), but that information is now unfortunately lost.
|
||||
|
||||
To aid this, you can use arrow `->`: (**note**: there is no space before and after `->`)
|
||||
|
||||
set -g @resurrect-processes '"~rails server->rails server"' # OK
|
||||
|
||||
This option says: "when this process is restored use `rails server` as the
|
||||
command name".
|
||||
|
||||
Full (long) process name is now ignored and you'll see just `rails server` in
|
||||
the command line when the program is restored.
|
||||
|
||||
> What is asterisk `*` and why is it used?
|
||||
|
||||
(Please read the above clarifications about tilde `~` and arrow `->`).
|
||||
|
||||
Continuing with the `rails server` example, you might have added flags for e.g.
|
||||
verbose logging, but with the above configuration, the flags would be lost.
|
||||
|
||||
To preserve the command arguments when restoring, use the asterisk `*`: (**note**: there **must** be a space before `*`)
|
||||
|
||||
set -g @resurrect-processes '"~rails server->rails server *"'
|
||||
|
||||
This option says: "when this process is restored use `rails server` as the
|
||||
command name, but preserve its arguments".
|
||||
|
||||
> Now I understand the tilde and the arrow, but things still don't work for me
|
||||
|
||||
Here's the general workflow for figuring this out:
|
||||
|
||||
- Set up your whole tmux environment manually.<br/>
|
||||
In our example case, we'd type `rails server` in a pane where we want it to
|
||||
run.
|
||||
- Save tmux env (it will get saved to `~/.tmux/resurrect/last`).
|
||||
- Open `~/.tmux/resurrect/last` file and try to find full process string for
|
||||
your program.<br/>
|
||||
Unfortunately this is a little vague but it should be easy. A smart
|
||||
thing to do for our example is to search for string `rails` in the `last`
|
||||
file.
|
||||
- Now that you know the full and the desired process string use tilde `~` and
|
||||
arrow `->` in `.tmux.conf` to make things work.
|
||||
|
||||
### Working with NodeJS <a name="nodejs"></a>
|
||||
If you are working with NodeJS, you may get some troubles with configuring restoring programs.
|
||||
|
||||
Particularly, some programs like `gulp`, `grunt` or `npm` are not saved with parameters so tmux-resurrect cannot restore it. This is actually **not tmux-resurrect's issue** but more likely, those programs' issues. For example if you run `gulp watch` or `npm start` and then try to look at `ps` or `pgrep`, you will only see `gulp` or `npm`.
|
||||
|
||||
To deal with these issues, one solution is to use [yarn](https://yarnpkg.com/en/docs/install) which a package manager for NodeJS and an alternative for `npm`. It's nearly identical to `npm` and very easy to use. Therefore you don't have to do any migration, you can simply use it immediately. For example:
|
||||
- `npm test` is equivalent to `yarn test`,
|
||||
- `npm run watch:dev` is equivalent to `yarn watch:dev`
|
||||
- more interestingly, `gulp watch:dev` is equivalent to `yarn gulp watch:dev`
|
||||
|
||||
Before continuing, please ensure that you understand the [clarifications](#clarifications) section about `~` and `->`
|
||||
|
||||
#### yarn
|
||||
It's fairly straight forward if you have been using `yarn` already.
|
||||
|
||||
set -g @resurrect-processes '"~yarn watch"'
|
||||
set -g @resurrect-processes '"~yarn watch->yarn watch"'
|
||||
|
||||
|
||||
#### npm
|
||||
Instead of
|
||||
|
||||
set -g @resurrect-processes '"~npm run watch"' # will NOT work
|
||||
|
||||
we use
|
||||
|
||||
set -g @resurrect-processes '"~yarn watch"' # OK
|
||||
|
||||
|
||||
#### gulp
|
||||
Instead of
|
||||
|
||||
set -g @resurrect-processes '"~gulp test"' # will NOT work
|
||||
|
||||
we use
|
||||
|
||||
set -g @resurrect-processes '"~yarn gulp test"' # OK
|
||||
|
||||
|
||||
#### nvm
|
||||
If you use `nvm` in your project, here is how you could config tmux-resurrect:
|
||||
|
||||
set -g @resurrect-processes '"~yarn gulp test->nvm use && gulp test"'
|
||||
|
||||
#### Another problem
|
||||
Let take a look at this example
|
||||
|
||||
set -g @resurrect-processes '\
|
||||
"~yarn gulp test->gulp test" \
|
||||
"~yarn gulp test-it->gulp test-it" \
|
||||
'
|
||||
**This will not work properly**, only `gulp test` is run, although you can see the command `node /path/to/yarn gulp test-it` is added correctly in `.tmux/resurrect/last` file.
|
||||
|
||||
The reason is when restoring program, the **command part after the dash `-` is ignored** so instead of command `gulp test-it`, the command `gulp test` which will be run.
|
||||
|
||||
A work around, for this problem until it's fixed, is:
|
||||
- the config should be like this:
|
||||
|
||||
set -g @resurrect-processes '\
|
||||
"~yarn gulp test->gulp test" \
|
||||
"~yarn gulp \"test-it\"->gulp test-it" \
|
||||
|
||||
- and in `.tmux/resurrect/last`, we should add quote to `test-it` word
|
||||
|
||||
... node:node /path/to/yarn gulp "test-it"
|
||||
|
||||
|
||||
### Restoring Mosh <a name="#mosh"></a>
|
||||
Mosh spawns a `mosh-client` process, so we need to specify that as the process to be resurrected.
|
||||
|
||||
set -g @resurrect-processes 'mosh-client'
|
||||
|
||||
Additionally a mosh-client strategy is provided to handle extracting the original arguments and re-run Mosh.
|
||||
|
|
@ -1,19 +0,0 @@
|
|||
# Restoring vim and neovim sessions
|
||||
|
||||
- save vim/neovim sessions. I recommend
|
||||
[tpope/vim-obsession](https://github.com/tpope/vim-obsession) (as almost every
|
||||
plugin, it works for both vim and neovim).
|
||||
- in `.tmux.conf`:
|
||||
|
||||
# for vim
|
||||
set -g @resurrect-strategy-vim 'session'
|
||||
# for neovim
|
||||
set -g @resurrect-strategy-nvim 'session'
|
||||
|
||||
`tmux-resurrect` will now restore vim and neovim sessions if `Session.vim` file
|
||||
is present.
|
||||
|
||||
> If you're using the vim binary provided by MacVim.app then you'll need to set `@resurrect-processes`, for example:
|
||||
> ```
|
||||
> set -g @resurrect-processes '~Vim -> vim'
|
||||
> ```
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
# Resurrect save dir
|
||||
|
||||
By default Tmux environment is saved to a file in `~/.tmux/resurrect` dir.
|
||||
Change this with:
|
||||
|
||||
set -g @resurrect-dir '/some/path'
|
||||
|
||||
Using environment variables or shell interpolation in this option is not
|
||||
allowed as the string is used literally. So the following won't do what is
|
||||
expected:
|
||||
|
||||
set -g @resurrect-dir '/path/$MY_VAR/$(some_executable)'
|
||||
|
||||
Only the following variables and special chars are allowed:
|
||||
`$HOME`, `$HOSTNAME`, and `~`.
|
||||
|
|
@ -1 +0,0 @@
|
|||
Subproject commit c38f488f152af6f6fd688ecdcf2728498813a01d
|
||||
|
|
@ -22,19 +22,12 @@ set_restore_bindings() {
|
|||
}
|
||||
|
||||
set_default_strategies() {
|
||||
tmux set-option -gq "${restore_process_strategy_option}irb" "default_strategy"
|
||||
tmux set-option -gq "${restore_process_strategy_option}mosh-client" "default_strategy"
|
||||
}
|
||||
|
||||
set_script_path_options() {
|
||||
tmux set-option -gq "$save_path_option" "$CURRENT_DIR/scripts/save.sh"
|
||||
tmux set-option -gq "$restore_path_option" "$CURRENT_DIR/scripts/restore.sh"
|
||||
tmux set-option -g "${restore_process_strategy_option}irb" "default_strategy"
|
||||
}
|
||||
|
||||
main() {
|
||||
set_save_bindings
|
||||
set_restore_bindings
|
||||
set_default_strategies
|
||||
set_script_path_options
|
||||
}
|
||||
main
|
||||
|
|
|
|||
|
|
@ -1,26 +0,0 @@
|
|||
#!/usr/bin/env bash
|
||||
|
||||
CURRENT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
|
||||
|
||||
PANE_PID="$1"
|
||||
COMMAND_PID=$(pgrep -P $PANE_PID)
|
||||
|
||||
exit_safely_if_empty_ppid() {
|
||||
if [ -z "$PANE_PID" ]; then
|
||||
exit 0
|
||||
fi
|
||||
}
|
||||
|
||||
full_command() {
|
||||
[[ -z "$COMMAND_PID" ]] && exit 0
|
||||
# See: https://unix.stackexchange.com/a/567021
|
||||
# Avoid complications with system printf by using bash subshell interpolation.
|
||||
# This will properly escape sequences and null in cmdline.
|
||||
cat /proc/${COMMAND_PID}/cmdline | xargs -0 bash -c 'printf "%q " "$0" "$@"'
|
||||
}
|
||||
|
||||
main() {
|
||||
exit_safely_if_empty_ppid
|
||||
full_command
|
||||
}
|
||||
main
|
||||
|
|
@ -10,8 +10,15 @@ exit_safely_if_empty_ppid() {
|
|||
fi
|
||||
}
|
||||
|
||||
ps_command_flags() {
|
||||
case $(uname -s) in
|
||||
FreeBSD) echo "-ao" ;;
|
||||
*) echo "-eo" ;;
|
||||
esac
|
||||
}
|
||||
|
||||
full_command() {
|
||||
ps -ao "ppid,args" |
|
||||
ps "$(ps_command_flags)" "ppid command" |
|
||||
sed "s/^ *//" |
|
||||
grep "^${PANE_PID}" |
|
||||
cut -d' ' -f2-
|
||||
|
|
|
|||
|
|
@ -1,17 +1,7 @@
|
|||
if [ -d "$HOME/.tmux/resurrect" ]; then
|
||||
default_resurrect_dir="$HOME/.tmux/resurrect"
|
||||
else
|
||||
default_resurrect_dir="${XDG_DATA_HOME:-$HOME/.local/share}"/tmux/resurrect
|
||||
fi
|
||||
default_resurrect_dir="$HOME/.tmux/resurrect"
|
||||
resurrect_dir_option="@resurrect-dir"
|
||||
|
||||
SUPPORTED_VERSION="1.9"
|
||||
RESURRECT_FILE_PREFIX="tmux_resurrect"
|
||||
RESURRECT_FILE_EXTENSION="txt"
|
||||
_RESURRECT_DIR=""
|
||||
_RESURRECT_FILE_PATH=""
|
||||
|
||||
d=$'\t'
|
||||
|
||||
# helper functions
|
||||
get_tmux_option() {
|
||||
|
|
@ -59,101 +49,34 @@ remove_first_char() {
|
|||
echo "$1" | cut -c2-
|
||||
}
|
||||
|
||||
capture_pane_contents_option_on() {
|
||||
local option="$(get_tmux_option "$pane_contents_option" "off")"
|
||||
save_bash_history_option_on() {
|
||||
local option="$(get_tmux_option "$bash_history_option" "off")"
|
||||
[ "$option" == "on" ]
|
||||
}
|
||||
|
||||
files_differ() {
|
||||
! cmp -s "$1" "$2"
|
||||
}
|
||||
|
||||
get_grouped_sessions() {
|
||||
local grouped_sessions_dump="$1"
|
||||
export GROUPED_SESSIONS="${d}$(echo "$grouped_sessions_dump" | cut -f2 -d"$d" | tr "\\n" "$d")"
|
||||
}
|
||||
|
||||
is_session_grouped() {
|
||||
local session_name="$1"
|
||||
[[ "$GROUPED_SESSIONS" == *"${d}${session_name}${d}"* ]]
|
||||
}
|
||||
|
||||
# pane content file helpers
|
||||
|
||||
pane_contents_create_archive() {
|
||||
tar cf - -C "$(resurrect_dir)/save/" ./pane_contents/ |
|
||||
gzip > "$(pane_contents_archive_file)"
|
||||
}
|
||||
|
||||
pane_content_files_restore_from_archive() {
|
||||
local archive_file="$(pane_contents_archive_file)"
|
||||
if [ -f "$archive_file" ]; then
|
||||
mkdir -p "$(pane_contents_dir "restore")"
|
||||
gzip -d < "$archive_file" |
|
||||
tar xf - -C "$(resurrect_dir)/restore/"
|
||||
fi
|
||||
}
|
||||
|
||||
# path helpers
|
||||
|
||||
resurrect_dir() {
|
||||
if [ -z "$_RESURRECT_DIR" ]; then
|
||||
local path="$(get_tmux_option "$resurrect_dir_option" "$default_resurrect_dir")"
|
||||
# expands tilde, $HOME and $HOSTNAME if used in @resurrect-dir
|
||||
echo "$path" | sed "s,\$HOME,$HOME,g; s,\$HOSTNAME,$(hostname),g; s,\~,$HOME,g"
|
||||
else
|
||||
echo "$_RESURRECT_DIR"
|
||||
fi
|
||||
echo $(get_tmux_option "$resurrect_dir_option" "$default_resurrect_dir")
|
||||
}
|
||||
_RESURRECT_DIR="$(resurrect_dir)"
|
||||
|
||||
resurrect_file_path() {
|
||||
if [ -z "$_RESURRECT_FILE_PATH" ]; then
|
||||
local timestamp="$(date +"%Y%m%dT%H%M%S")"
|
||||
echo "$(resurrect_dir)/${RESURRECT_FILE_PREFIX}_${timestamp}.${RESURRECT_FILE_EXTENSION}"
|
||||
else
|
||||
echo "$_RESURRECT_FILE_PATH"
|
||||
fi
|
||||
local timestamp="$(date +"%Y-%m-%dT%H:%M:%S")"
|
||||
echo "$(resurrect_dir)/tmux_resurrect_${timestamp}.txt"
|
||||
}
|
||||
_RESURRECT_FILE_PATH="$(resurrect_file_path)"
|
||||
|
||||
last_resurrect_file() {
|
||||
echo "$(resurrect_dir)/last"
|
||||
}
|
||||
|
||||
pane_contents_dir() {
|
||||
echo "$(resurrect_dir)/$1/pane_contents/"
|
||||
}
|
||||
|
||||
pane_contents_file() {
|
||||
local save_or_restore="$1"
|
||||
local pane_id="$2"
|
||||
echo "$(pane_contents_dir "$save_or_restore")/pane-${pane_id}"
|
||||
}
|
||||
|
||||
pane_contents_file_exists() {
|
||||
resurrect_history_file() {
|
||||
local pane_id="$1"
|
||||
[ -f "$(pane_contents_file "restore" "$pane_id")" ]
|
||||
echo "$(resurrect_dir)/bash_history-${pane_id}"
|
||||
}
|
||||
|
||||
pane_contents_archive_file() {
|
||||
echo "$(resurrect_dir)/pane_contents.tar.gz"
|
||||
}
|
||||
|
||||
execute_hook() {
|
||||
local kind="$1"
|
||||
shift
|
||||
local args="" hook=""
|
||||
|
||||
hook=$(get_tmux_option "$hook_prefix$kind" "")
|
||||
|
||||
# If there are any args, pass them to the hook (in a way that preserves/copes
|
||||
# with spaces and unusual characters.
|
||||
if [ "$#" -gt 0 ]; then
|
||||
printf -v args "%q " "$@"
|
||||
fi
|
||||
|
||||
if [ -n "$hook" ]; then
|
||||
eval "$hook $args"
|
||||
fi
|
||||
restore_zoomed_windows() {
|
||||
awk 'BEGIN { FS="\t"; OFS="\t" } /^pane/ && $6 ~ /Z/ && $9 == 1 { print $2, $3; }' $(last_resurrect_file) |
|
||||
while IFS=$'\t' read session_name window_number; do
|
||||
tmux resize-pane -t "${session_name}:${window_number}" -Z
|
||||
done
|
||||
}
|
||||
|
|
|
|||
|
|
@ -13,7 +13,6 @@ restore_pane_process() {
|
|||
local window_number="$3"
|
||||
local pane_index="$4"
|
||||
local dir="$5"
|
||||
local command
|
||||
if _process_should_be_restored "$pane_full_command" "$session_name" "$window_number" "$pane_index"; then
|
||||
tmux switch-client -t "${session_name}:${window_number}"
|
||||
tmux select-pane -t "$pane_index"
|
||||
|
|
@ -21,21 +20,15 @@ restore_pane_process() {
|
|||
local inline_strategy="$(_get_inline_strategy "$pane_full_command")" # might not be defined
|
||||
if [ -n "$inline_strategy" ]; then
|
||||
# inline strategy exists
|
||||
# check for additional "expansion" of inline strategy, e.g. `vim` to `vim -S`
|
||||
if _strategy_exists "$inline_strategy"; then
|
||||
local strategy_file="$(_get_strategy_file "$inline_strategy")"
|
||||
local inline_strategy="$($strategy_file "$pane_full_command" "$dir")"
|
||||
fi
|
||||
command="$inline_strategy"
|
||||
tmux send-keys "$inline_strategy" "C-m"
|
||||
elif _strategy_exists "$pane_full_command"; then
|
||||
local strategy_file="$(_get_strategy_file "$pane_full_command")"
|
||||
local strategy_command="$($strategy_file "$pane_full_command" "$dir")"
|
||||
command="$strategy_command"
|
||||
tmux send-keys "$strategy_command" "C-m"
|
||||
else
|
||||
# just invoke the raw command
|
||||
command="$pane_full_command"
|
||||
# just invoke the command
|
||||
tmux send-keys "$pane_full_command" "C-m"
|
||||
fi
|
||||
tmux send-keys -t "${session_name}:${window_number}.${pane_index}" "$command" "C-m"
|
||||
fi
|
||||
}
|
||||
|
||||
|
|
@ -112,32 +105,6 @@ _get_proc_restore_element() {
|
|||
echo "$1" | sed "s/.*${inline_strategy_token}//"
|
||||
}
|
||||
|
||||
# given full command: 'ruby /Users/john/bin/my_program arg1 arg2'
|
||||
# and inline strategy: '~bin/my_program->my_program *'
|
||||
# returns: 'arg1 arg2'
|
||||
_get_command_arguments() {
|
||||
local pane_full_command="$1"
|
||||
local match="$2"
|
||||
if _proc_starts_with_tildae "$match"; then
|
||||
match="$(remove_first_char "$match")"
|
||||
fi
|
||||
echo "$pane_full_command" | sed "s,^.*${match}[^ ]* *,,"
|
||||
}
|
||||
|
||||
_get_proc_restore_command() {
|
||||
local pane_full_command="$1"
|
||||
local proc="$2"
|
||||
local match="$3"
|
||||
local restore_element="$(_get_proc_restore_element "$proc")"
|
||||
if [[ "$restore_element" =~ " ${inline_strategy_arguments_token}" ]]; then
|
||||
# replaces "%" with command arguments
|
||||
local command_arguments="$(_get_command_arguments "$pane_full_command" "$match")"
|
||||
echo "$restore_element" | sed "s,${inline_strategy_arguments_token},${command_arguments},"
|
||||
else
|
||||
echo "$restore_element"
|
||||
fi
|
||||
}
|
||||
|
||||
_restore_list() {
|
||||
local user_processes="$(get_tmux_option "$restore_processes_option" "$restore_processes")"
|
||||
local default_processes="$(get_tmux_option "$default_proc_list_option" "$default_proc_list")"
|
||||
|
|
@ -163,7 +130,7 @@ _get_inline_strategy() {
|
|||
if [[ "$proc" =~ "$inline_strategy_token" ]]; then
|
||||
match="$(_get_proc_match_element "$proc")"
|
||||
if _proc_matches_full_command "$pane_full_command" "$match"; then
|
||||
echo "$(_get_proc_restore_command "$pane_full_command" "$proc" "$match")"
|
||||
echo "$(_get_proc_restore_element "$proc")"
|
||||
fi
|
||||
fi
|
||||
done
|
||||
|
|
|
|||
|
|
@ -7,19 +7,12 @@ source "$CURRENT_DIR/helpers.sh"
|
|||
source "$CURRENT_DIR/process_restore_helpers.sh"
|
||||
source "$CURRENT_DIR/spinner_helpers.sh"
|
||||
|
||||
# delimiter
|
||||
d=$'\t'
|
||||
|
||||
# Global variable.
|
||||
# Used during the restore: if a pane already exists from before, it is
|
||||
# saved in the array in this variable. Later, process running in existing pane
|
||||
# is also not restored. That makes the restoration process more idempotent.
|
||||
EXISTING_PANES_VAR=""
|
||||
|
||||
RESTORING_FROM_SCRATCH="false"
|
||||
|
||||
RESTORE_PANE_CONTENTS="false"
|
||||
|
||||
is_line_type() {
|
||||
local line_type="$1"
|
||||
local line="$2"
|
||||
|
|
@ -60,30 +53,6 @@ is_pane_registered_as_existing() {
|
|||
[[ "$EXISTING_PANES_VAR" =~ "$pane_custom_id" ]]
|
||||
}
|
||||
|
||||
restore_from_scratch_true() {
|
||||
RESTORING_FROM_SCRATCH="true"
|
||||
}
|
||||
|
||||
is_restoring_from_scratch() {
|
||||
[ "$RESTORING_FROM_SCRATCH" == "true" ]
|
||||
}
|
||||
|
||||
restore_pane_contents_true() {
|
||||
RESTORE_PANE_CONTENTS="true"
|
||||
}
|
||||
|
||||
is_restoring_pane_contents() {
|
||||
[ "$RESTORE_PANE_CONTENTS" == "true" ]
|
||||
}
|
||||
|
||||
restored_session_0_true() {
|
||||
RESTORED_SESSION_0="true"
|
||||
}
|
||||
|
||||
has_restored_session_0() {
|
||||
[ "$RESTORED_SESSION_0" == "true" ]
|
||||
}
|
||||
|
||||
window_exists() {
|
||||
local session_name="$1"
|
||||
local window_number="$2"
|
||||
|
|
@ -104,52 +73,20 @@ tmux_socket() {
|
|||
echo $TMUX | cut -d',' -f1
|
||||
}
|
||||
|
||||
# Tmux option stored in a global variable so that we don't have to "ask"
|
||||
# tmux server each time.
|
||||
cache_tmux_default_command() {
|
||||
local default_shell="$(get_tmux_option "default-shell" "")"
|
||||
local opt=""
|
||||
if [ "$(basename "$default_shell")" == "bash" ]; then
|
||||
opt="-l "
|
||||
fi
|
||||
export TMUX_DEFAULT_COMMAND="$(get_tmux_option "default-command" "$opt$default_shell")"
|
||||
}
|
||||
|
||||
tmux_default_command() {
|
||||
echo "$TMUX_DEFAULT_COMMAND"
|
||||
}
|
||||
|
||||
pane_creation_command() {
|
||||
echo "cat '$(pane_contents_file "restore" "${1}:${2}.${3}")'; exec $(tmux_default_command)"
|
||||
}
|
||||
|
||||
new_window() {
|
||||
local session_name="$1"
|
||||
local window_number="$2"
|
||||
local dir="$3"
|
||||
local pane_index="$4"
|
||||
local pane_id="${session_name}:${window_number}.${pane_index}"
|
||||
dir="${dir/#\~/$HOME}"
|
||||
if is_restoring_pane_contents && pane_contents_file_exists "$pane_id"; then
|
||||
local pane_creation_command="$(pane_creation_command "$session_name" "$window_number" "$pane_index")"
|
||||
tmux new-window -d -t "${session_name}:${window_number}" -c "$dir" "$pane_creation_command"
|
||||
else
|
||||
tmux new-window -d -t "${session_name}:${window_number}" -c "$dir"
|
||||
fi
|
||||
local window_name="$3"
|
||||
local dir="$4"
|
||||
tmux new-window -d -t "${session_name}:${window_number}" -n "$window_name" -c "$dir"
|
||||
}
|
||||
|
||||
new_session() {
|
||||
local session_name="$1"
|
||||
local window_number="$2"
|
||||
local dir="$3"
|
||||
local pane_index="$4"
|
||||
local pane_id="${session_name}:${window_number}.${pane_index}"
|
||||
if is_restoring_pane_contents && pane_contents_file_exists "$pane_id"; then
|
||||
local pane_creation_command="$(pane_creation_command "$session_name" "$window_number" "$pane_index")"
|
||||
TMUX="" tmux -S "$(tmux_socket)" new-session -d -s "$session_name" -c "$dir" "$pane_creation_command"
|
||||
else
|
||||
TMUX="" tmux -S "$(tmux_socket)" new-session -d -s "$session_name" -c "$dir"
|
||||
fi
|
||||
local window_name="$3"
|
||||
local dir="$4"
|
||||
TMUX="" tmux -S "$(tmux_socket)" new-session -d -s "$session_name" -n "$window_name" -c "$dir"
|
||||
# change first window number if necessary
|
||||
local created_window_num="$(first_window_num)"
|
||||
if [ $created_window_num -ne $window_number ]; then
|
||||
|
|
@ -160,113 +97,43 @@ new_session() {
|
|||
new_pane() {
|
||||
local session_name="$1"
|
||||
local window_number="$2"
|
||||
local dir="$3"
|
||||
local pane_index="$4"
|
||||
local pane_id="${session_name}:${window_number}.${pane_index}"
|
||||
if is_restoring_pane_contents && pane_contents_file_exists "$pane_id"; then
|
||||
local pane_creation_command="$(pane_creation_command "$session_name" "$window_number" "$pane_index")"
|
||||
tmux split-window -t "${session_name}:${window_number}" -c "$dir" "$pane_creation_command"
|
||||
else
|
||||
tmux split-window -t "${session_name}:${window_number}" -c "$dir"
|
||||
fi
|
||||
local window_name="$3"
|
||||
local dir="$4"
|
||||
tmux split-window -t "${session_name}:${window_number}" -c "$dir"
|
||||
# minimize window so more panes can fit
|
||||
tmux resize-pane -t "${session_name}:${window_number}" -U "999"
|
||||
tmux resize-pane -t "${session_name}:${window_number}" -U "999"
|
||||
}
|
||||
|
||||
restore_pane() {
|
||||
local pane="$1"
|
||||
while IFS=$d read line_type session_name window_number window_active window_flags pane_index pane_title dir pane_active pane_command pane_full_command; do
|
||||
while IFS=$'\t' read line_type session_name window_number window_name window_active window_flags pane_index dir pane_active pane_command pane_full_command; do
|
||||
dir="$(remove_first_char "$dir")"
|
||||
window_name="$(remove_first_char "$window_name")"
|
||||
pane_full_command="$(remove_first_char "$pane_full_command")"
|
||||
if [ "$session_name" == "0" ]; then
|
||||
restored_session_0_true
|
||||
fi
|
||||
if pane_exists "$session_name" "$window_number" "$pane_index"; then
|
||||
if is_restoring_from_scratch; then
|
||||
# overwrite the pane
|
||||
# happens only for the first pane if it's the only registered pane for the whole tmux server
|
||||
local pane_id="$(tmux display-message -p -F "#{pane_id}" -t "$session_name:$window_number")"
|
||||
new_pane "$session_name" "$window_number" "$dir" "$pane_index"
|
||||
tmux kill-pane -t "$pane_id"
|
||||
else
|
||||
# Pane exists, no need to create it!
|
||||
# Pane existence is registered. Later, its process also won't be restored.
|
||||
register_existing_pane "$session_name" "$window_number" "$pane_index"
|
||||
fi
|
||||
# Pane exists, no need to create it!
|
||||
# Pane existence is registered. Later, it's process also isn't restored.
|
||||
register_existing_pane "$session_name" "$window_number" "$pane_index"
|
||||
elif window_exists "$session_name" "$window_number"; then
|
||||
new_pane "$session_name" "$window_number" "$dir" "$pane_index"
|
||||
new_pane "$session_name" "$window_number" "$window_name" "$dir"
|
||||
elif session_exists "$session_name"; then
|
||||
new_window "$session_name" "$window_number" "$dir" "$pane_index"
|
||||
new_window "$session_name" "$window_number" "$window_name" "$dir"
|
||||
else
|
||||
new_session "$session_name" "$window_number" "$dir" "$pane_index"
|
||||
new_session "$session_name" "$window_number" "$window_name" "$dir"
|
||||
fi
|
||||
# set pane title
|
||||
tmux select-pane -t "$session_name:$window_number.$pane_index" -T "$pane_title"
|
||||
done < <(echo "$pane")
|
||||
}
|
||||
|
||||
restore_state() {
|
||||
local state="$1"
|
||||
echo "$state" |
|
||||
while IFS=$d read line_type client_session client_last_session; do
|
||||
while IFS=$'\t' read line_type client_session client_last_session; do
|
||||
tmux switch-client -t "$client_last_session"
|
||||
tmux switch-client -t "$client_session"
|
||||
done
|
||||
}
|
||||
|
||||
restore_grouped_session() {
|
||||
local grouped_session="$1"
|
||||
echo "$grouped_session" |
|
||||
while IFS=$d read line_type grouped_session original_session alternate_window active_window; do
|
||||
TMUX="" tmux -S "$(tmux_socket)" new-session -d -s "$grouped_session" -t "$original_session"
|
||||
done
|
||||
}
|
||||
|
||||
restore_active_and_alternate_windows_for_grouped_sessions() {
|
||||
local grouped_session="$1"
|
||||
echo "$grouped_session" |
|
||||
while IFS=$d read line_type grouped_session original_session alternate_window_index active_window_index; do
|
||||
alternate_window_index="$(remove_first_char "$alternate_window_index")"
|
||||
active_window_index="$(remove_first_char "$active_window_index")"
|
||||
if [ -n "$alternate_window_index" ]; then
|
||||
tmux switch-client -t "${grouped_session}:${alternate_window_index}"
|
||||
fi
|
||||
if [ -n "$active_window_index" ]; then
|
||||
tmux switch-client -t "${grouped_session}:${active_window_index}"
|
||||
fi
|
||||
done
|
||||
}
|
||||
|
||||
never_ever_overwrite() {
|
||||
local overwrite_option_value="$(get_tmux_option "$overwrite_option" "")"
|
||||
[ -n "$overwrite_option_value" ]
|
||||
}
|
||||
|
||||
detect_if_restoring_from_scratch() {
|
||||
if never_ever_overwrite; then
|
||||
return
|
||||
fi
|
||||
local total_number_of_panes="$(tmux list-panes -a | wc -l | sed 's/ //g')"
|
||||
if [ "$total_number_of_panes" -eq 1 ]; then
|
||||
restore_from_scratch_true
|
||||
fi
|
||||
}
|
||||
|
||||
detect_if_restoring_pane_contents() {
|
||||
if capture_pane_contents_option_on; then
|
||||
cache_tmux_default_command
|
||||
restore_pane_contents_true
|
||||
fi
|
||||
}
|
||||
|
||||
# functions called from main (ordered)
|
||||
|
||||
restore_all_panes() {
|
||||
detect_if_restoring_from_scratch # sets a global variable
|
||||
detect_if_restoring_pane_contents # sets a global variable
|
||||
if is_restoring_pane_contents; then
|
||||
pane_content_files_restore_from_archive
|
||||
fi
|
||||
while read line; do
|
||||
if is_line_type "pane" "$line"; then
|
||||
restore_pane "$line"
|
||||
|
|
@ -274,31 +141,17 @@ restore_all_panes() {
|
|||
done < $(last_resurrect_file)
|
||||
}
|
||||
|
||||
handle_session_0() {
|
||||
if is_restoring_from_scratch && ! has_restored_session_0; then
|
||||
local current_session="$(tmux display -p "#{client_session}")"
|
||||
if [ "$current_session" == "0" ]; then
|
||||
tmux switch-client -n
|
||||
fi
|
||||
tmux kill-session -t "0"
|
||||
fi
|
||||
}
|
||||
|
||||
restore_window_properties() {
|
||||
local window_name
|
||||
\grep '^window' $(last_resurrect_file) |
|
||||
while IFS=$d read line_type session_name window_number window_name window_active window_flags window_layout automatic_rename; do
|
||||
tmux select-layout -t "${session_name}:${window_number}" "$window_layout"
|
||||
|
||||
# Below steps are properly handling window names and automatic-rename
|
||||
# option. `rename-window` is an extra command in some scenarios, but we
|
||||
# opted for always doing it to keep the code simple.
|
||||
window_name="$(remove_first_char "$window_name")"
|
||||
tmux rename-window -t "${session_name}:${window_number}" "$window_name"
|
||||
if [ "${automatic_rename}" = ":" ]; then
|
||||
tmux set-option -u -t "${session_name}:${window_number}" automatic-rename
|
||||
else
|
||||
tmux set-option -t "${session_name}:${window_number}" automatic-rename "$automatic_rename"
|
||||
restore_shell_history() {
|
||||
awk 'BEGIN { FS="\t"; OFS="\t" } /^pane/ { print $2, $3, $7, $10; }' $(last_resurrect_file) |
|
||||
while IFS=$'\t' read session_name window_number pane_index pane_command; do
|
||||
if ! is_pane_registered_as_existing "$session_name" "$window_number" "$pane_index"; then
|
||||
if [ "$pane_command" = "bash" ]; then
|
||||
local pane_id="$session_name:$window_number.$pane_index"
|
||||
# tmux send-keys has -R option that should reset the terminal.
|
||||
# However, appending 'clear' to the command seems to work more reliably.
|
||||
local read_command="history -r '$(resurrect_history_file "$pane_id")'; clear"
|
||||
tmux send-keys -t "$pane_id" "$read_command" C-m
|
||||
fi
|
||||
fi
|
||||
done
|
||||
}
|
||||
|
|
@ -306,8 +159,8 @@ restore_window_properties() {
|
|||
restore_all_pane_processes() {
|
||||
if restore_pane_processes_enabled; then
|
||||
local pane_full_command
|
||||
awk 'BEGIN { FS="\t"; OFS="\t" } /^pane/ && $11 !~ "^:$" { print $2, $3, $6, $8, $11; }' $(last_resurrect_file) |
|
||||
while IFS=$d read -r session_name window_number pane_index dir pane_full_command; do
|
||||
awk 'BEGIN { FS="\t"; OFS="\t" } /^pane/ && $11 !~ "^:$" { print $2, $3, $7, $8, $11; }' $(last_resurrect_file) |
|
||||
while IFS=$'\t' read session_name window_number pane_index dir pane_full_command; do
|
||||
dir="$(remove_first_char "$dir")"
|
||||
pane_full_command="$(remove_first_char "$pane_full_command")"
|
||||
restore_pane_process "$pane_full_command" "$session_name" "$window_number" "$pane_index" "$dir"
|
||||
|
|
@ -315,34 +168,25 @@ restore_all_pane_processes() {
|
|||
fi
|
||||
}
|
||||
|
||||
restore_pane_layout_for_each_window() {
|
||||
\grep '^window' $(last_resurrect_file) |
|
||||
while IFS=$'\t' read line_type session_name window_number window_active window_flags window_layout; do
|
||||
tmux select-layout -t "${session_name}:${window_number}" "$window_layout"
|
||||
done
|
||||
}
|
||||
|
||||
restore_active_pane_for_each_window() {
|
||||
awk 'BEGIN { FS="\t"; OFS="\t" } /^pane/ && $9 == 1 { print $2, $3, $6; }' $(last_resurrect_file) |
|
||||
while IFS=$d read session_name window_number active_pane; do
|
||||
awk 'BEGIN { FS="\t"; OFS="\t" } /^pane/ && $9 == 1 { print $2, $3, $7; }' $(last_resurrect_file) |
|
||||
while IFS=$'\t' read session_name window_number active_pane; do
|
||||
tmux switch-client -t "${session_name}:${window_number}"
|
||||
tmux select-pane -t "$active_pane"
|
||||
done
|
||||
}
|
||||
|
||||
restore_zoomed_windows() {
|
||||
awk 'BEGIN { FS="\t"; OFS="\t" } /^pane/ && $5 ~ /Z/ && $9 == 1 { print $2, $3; }' $(last_resurrect_file) |
|
||||
while IFS=$d read session_name window_number; do
|
||||
tmux resize-pane -t "${session_name}:${window_number}" -Z
|
||||
done
|
||||
}
|
||||
|
||||
restore_grouped_sessions() {
|
||||
while read line; do
|
||||
if is_line_type "grouped_session" "$line"; then
|
||||
restore_grouped_session "$line"
|
||||
restore_active_and_alternate_windows_for_grouped_sessions "$line"
|
||||
fi
|
||||
done < $(last_resurrect_file)
|
||||
}
|
||||
|
||||
restore_active_and_alternate_windows() {
|
||||
awk 'BEGIN { FS="\t"; OFS="\t" } /^window/ && $6 ~ /[*-]/ { print $2, $5, $3; }' $(last_resurrect_file) |
|
||||
awk 'BEGIN { FS="\t"; OFS="\t" } /^window/ && $5 ~ /[*-]/ { print $2, $4, $3; }' $(last_resurrect_file) |
|
||||
sort -u |
|
||||
while IFS=$d read session_name active_window window_number; do
|
||||
while IFS=$'\t' read session_name active_window window_number; do
|
||||
tmux switch-client -t "${session_name}:${window_number}"
|
||||
done
|
||||
}
|
||||
|
|
@ -355,31 +199,20 @@ restore_active_and_alternate_sessions() {
|
|||
done < $(last_resurrect_file)
|
||||
}
|
||||
|
||||
# A cleanup that happens after 'restore_all_panes' seems to fix fish shell
|
||||
# users' restore problems.
|
||||
cleanup_restored_pane_contents() {
|
||||
if is_restoring_pane_contents; then
|
||||
rm "$(pane_contents_dir "restore")"/*
|
||||
fi
|
||||
}
|
||||
|
||||
main() {
|
||||
if supported_tmux_version_ok && check_saved_session_exists; then
|
||||
start_spinner "Restoring..." "Tmux restore complete!"
|
||||
execute_hook "pre-restore-all"
|
||||
restore_all_panes
|
||||
handle_session_0
|
||||
restore_window_properties >/dev/null 2>&1
|
||||
execute_hook "pre-restore-pane-processes"
|
||||
restore_pane_layout_for_each_window >/dev/null 2>&1
|
||||
if save_bash_history_option_on; then
|
||||
restore_shell_history
|
||||
fi
|
||||
restore_all_pane_processes
|
||||
# below functions restore exact cursor positions
|
||||
restore_active_pane_for_each_window
|
||||
restore_zoomed_windows
|
||||
restore_grouped_sessions # also restores active and alt windows for grouped sessions
|
||||
restore_active_and_alternate_windows
|
||||
restore_active_and_alternate_sessions
|
||||
cleanup_restored_pane_contents
|
||||
execute_hook "post-restore-all"
|
||||
stop_spinner
|
||||
display_message "Tmux restore complete!"
|
||||
fi
|
||||
|
|
|
|||
244
scripts/save.sh
244
scripts/save.sh
|
|
@ -6,26 +6,8 @@ source "$CURRENT_DIR/variables.sh"
|
|||
source "$CURRENT_DIR/helpers.sh"
|
||||
source "$CURRENT_DIR/spinner_helpers.sh"
|
||||
|
||||
# delimiters
|
||||
d=$'\t'
|
||||
delimiter=$'\t'
|
||||
|
||||
# if "quiet" script produces no output
|
||||
SCRIPT_OUTPUT="$1"
|
||||
|
||||
grouped_sessions_format() {
|
||||
local format
|
||||
format+="#{session_grouped}"
|
||||
format+="${delimiter}"
|
||||
format+="#{session_group}"
|
||||
format+="${delimiter}"
|
||||
format+="#{session_id}"
|
||||
format+="${delimiter}"
|
||||
format+="#{session_name}"
|
||||
echo "$format"
|
||||
}
|
||||
|
||||
pane_format() {
|
||||
local delimiter=$'\t'
|
||||
local format
|
||||
format+="pane"
|
||||
format+="${delimiter}"
|
||||
|
|
@ -33,45 +15,43 @@ pane_format() {
|
|||
format+="${delimiter}"
|
||||
format+="#{window_index}"
|
||||
format+="${delimiter}"
|
||||
format+="#{window_active}"
|
||||
format+="${delimiter}"
|
||||
format+=":#{window_flags}"
|
||||
format+="${delimiter}"
|
||||
format+="#{pane_index}"
|
||||
format+="${delimiter}"
|
||||
format+="#{pane_title}"
|
||||
format+="${delimiter}"
|
||||
format+=":#{pane_current_path}"
|
||||
format+="${delimiter}"
|
||||
format+="#{pane_active}"
|
||||
format+="${delimiter}"
|
||||
format+="#{pane_current_command}"
|
||||
format+="${delimiter}"
|
||||
format+="#{pane_pid}"
|
||||
format+="${delimiter}"
|
||||
format+="#{history_size}"
|
||||
echo "$format"
|
||||
}
|
||||
|
||||
window_format() {
|
||||
local format
|
||||
format+="window"
|
||||
format+="${delimiter}"
|
||||
format+="#{session_name}"
|
||||
format+="${delimiter}"
|
||||
format+="#{window_index}"
|
||||
format+="${delimiter}"
|
||||
format+=":#{window_name}"
|
||||
format+="${delimiter}"
|
||||
format+="#{window_active}"
|
||||
format+="${delimiter}"
|
||||
format+=":#{window_flags}"
|
||||
format+="${delimiter}"
|
||||
format+="#{pane_index}"
|
||||
format+="${delimiter}"
|
||||
format+=":#{pane_current_path}"
|
||||
format+="${delimiter}"
|
||||
format+="#{pane_active}"
|
||||
format+="${delimiter}"
|
||||
format+="#{pane_current_command}"
|
||||
format+="${delimiter}"
|
||||
format+="#{pane_pid}"
|
||||
echo "$format"
|
||||
}
|
||||
|
||||
window_format() {
|
||||
local delimiter=$'\t'
|
||||
local format
|
||||
format+="window"
|
||||
format+="${delimiter}"
|
||||
format+="#{session_name}"
|
||||
format+="${delimiter}"
|
||||
format+="#{window_index}"
|
||||
format+="${delimiter}"
|
||||
format+="#{window_active}"
|
||||
format+="${delimiter}"
|
||||
format+=":#{window_flags}"
|
||||
format+="${delimiter}"
|
||||
format+="#{window_layout}"
|
||||
echo "$format"
|
||||
}
|
||||
|
||||
state_format() {
|
||||
local delimiter=$'\t'
|
||||
local format
|
||||
format+="state"
|
||||
format+="${delimiter}"
|
||||
|
|
@ -85,15 +65,6 @@ dump_panes_raw() {
|
|||
tmux list-panes -a -F "$(pane_format)"
|
||||
}
|
||||
|
||||
dump_windows_raw(){
|
||||
tmux list-windows -a -F "$(window_format)"
|
||||
}
|
||||
|
||||
toggle_window_zoom() {
|
||||
local target="$1"
|
||||
tmux resize-pane -Z -t "$target"
|
||||
}
|
||||
|
||||
_save_command_strategy_file() {
|
||||
local save_command_strategy="$(get_tmux_option "$save_command_strategy_option" "$default_save_command_strategy")"
|
||||
local strategy_file="$CURRENT_DIR/../save_command_strategies/${save_command_strategy}.sh"
|
||||
|
|
@ -112,167 +83,70 @@ pane_full_command() {
|
|||
$strategy_file "$pane_pid"
|
||||
}
|
||||
|
||||
number_nonempty_lines_on_screen() {
|
||||
save_shell_history() {
|
||||
local pane_id="$1"
|
||||
tmux capture-pane -pJ -t "$pane_id" |
|
||||
sed '/^$/d' |
|
||||
wc -l |
|
||||
sed 's/ //g'
|
||||
}
|
||||
|
||||
# tests if there was any command output in the current pane
|
||||
pane_has_any_content() {
|
||||
local pane_id="$1"
|
||||
local history_size="$(tmux display -p -t "$pane_id" -F "#{history_size}")"
|
||||
local cursor_y="$(tmux display -p -t "$pane_id" -F "#{cursor_y}")"
|
||||
# doing "cheap" tests first
|
||||
[ "$history_size" -gt 0 ] || # history has any content?
|
||||
[ "$cursor_y" -gt 0 ] || # cursor not in first line?
|
||||
[ "$(number_nonempty_lines_on_screen "$pane_id")" -gt 1 ]
|
||||
}
|
||||
|
||||
capture_pane_contents() {
|
||||
local pane_id="$1"
|
||||
local start_line="-$2"
|
||||
local pane_contents_area="$3"
|
||||
if pane_has_any_content "$pane_id"; then
|
||||
if [ "$pane_contents_area" = "visible" ]; then
|
||||
start_line="0"
|
||||
fi
|
||||
# the printf hack below removes *trailing* empty lines
|
||||
printf '%s\n' "$(tmux capture-pane -epJ -S "$start_line" -t "$pane_id")" > "$(pane_contents_file "save" "$pane_id")"
|
||||
fi
|
||||
}
|
||||
|
||||
get_active_window_index() {
|
||||
local session_name="$1"
|
||||
tmux list-windows -t "$session_name" -F "#{window_flags} #{window_index}" |
|
||||
awk '$1 ~ /\*/ { print $2; }'
|
||||
}
|
||||
|
||||
get_alternate_window_index() {
|
||||
local session_name="$1"
|
||||
tmux list-windows -t "$session_name" -F "#{window_flags} #{window_index}" |
|
||||
awk '$1 ~ /-/ { print $2; }'
|
||||
}
|
||||
|
||||
dump_grouped_sessions() {
|
||||
local current_session_group=""
|
||||
local original_session
|
||||
tmux list-sessions -F "$(grouped_sessions_format)" |
|
||||
grep "^1" |
|
||||
cut -c 3- |
|
||||
sort |
|
||||
while IFS=$d read session_group session_id session_name; do
|
||||
if [ "$session_group" != "$current_session_group" ]; then
|
||||
# this session is the original/first session in the group
|
||||
original_session="$session_name"
|
||||
current_session_group="$session_group"
|
||||
else
|
||||
# this session "points" to the original session
|
||||
active_window_index="$(get_active_window_index "$session_name")"
|
||||
alternate_window_index="$(get_alternate_window_index "$session_name")"
|
||||
echo "grouped_session${d}${session_name}${d}${original_session}${d}:${alternate_window_index}${d}:${active_window_index}"
|
||||
fi
|
||||
done
|
||||
}
|
||||
|
||||
fetch_and_dump_grouped_sessions(){
|
||||
local grouped_sessions_dump="$(dump_grouped_sessions)"
|
||||
get_grouped_sessions "$grouped_sessions_dump"
|
||||
if [ -n "$grouped_sessions_dump" ]; then
|
||||
echo "$grouped_sessions_dump"
|
||||
local pane_command="$2"
|
||||
local full_command="$3"
|
||||
if [ "$pane_command" = "bash" ] && [ "$full_command" = ":" ]; then
|
||||
# leading space prevents the command from being saved to history
|
||||
# (assuming default HISTCONTROL settings)
|
||||
local write_command=" history -w '$(resurrect_history_file "$pane_id")'"
|
||||
# C-e C-u is a Bash shortcut sequence to clear whole line. It is necessary to
|
||||
# delete any pending input so it does not interfere with our history command.
|
||||
tmux send-keys -t "$pane_id" C-e C-u "$write_command" C-m
|
||||
fi
|
||||
}
|
||||
|
||||
# translates pane pid to process command running inside a pane
|
||||
dump_panes() {
|
||||
local full_command
|
||||
local d=$'\t' # delimiter
|
||||
dump_panes_raw |
|
||||
while IFS=$d read line_type session_name window_number window_active window_flags pane_index pane_title dir pane_active pane_command pane_pid history_size; do
|
||||
# not saving panes from grouped sessions
|
||||
if is_session_grouped "$session_name"; then
|
||||
continue
|
||||
while IFS=$'\t' read line_type session_name window_number window_name window_active window_flags pane_index dir pane_active pane_command pane_pid; do
|
||||
# check if current pane is part of a maximized window and if the pane is active
|
||||
if [[ "${window_flags}" == *Z* ]] && [[ ${pane_active} == 1 ]]; then
|
||||
# unmaximize the pane
|
||||
tmux resize-pane -Z -t "${session_name}:${window_number}"
|
||||
fi
|
||||
full_command="$(pane_full_command $pane_pid)"
|
||||
dir=$(echo $dir | sed 's/ /\\ /') # escape all spaces in directory path
|
||||
echo "${line_type}${d}${session_name}${d}${window_number}${d}${window_active}${d}${window_flags}${d}${pane_index}${d}${pane_title}${d}${dir}${d}${pane_active}${d}${pane_command}${d}:${full_command}"
|
||||
echo "${line_type}${d}${session_name}${d}${window_number}${d}${window_name}${d}${window_active}${d}${window_flags}${d}${pane_index}${d}${dir}${d}${pane_active}${d}${pane_command}${d}:${full_command}"
|
||||
done
|
||||
}
|
||||
|
||||
dump_windows() {
|
||||
dump_windows_raw |
|
||||
while IFS=$d read line_type session_name window_index window_name window_active window_flags window_layout; do
|
||||
# not saving windows from grouped sessions
|
||||
if is_session_grouped "$session_name"; then
|
||||
continue
|
||||
fi
|
||||
automatic_rename="$(tmux show-window-options -vt "${session_name}:${window_index}" automatic-rename)"
|
||||
# If the option was unset, use ":" as a placeholder.
|
||||
[ -z "${automatic_rename}" ] && automatic_rename=":"
|
||||
echo "${line_type}${d}${session_name}${d}${window_index}${d}${window_name}${d}${window_active}${d}${window_flags}${d}${window_layout}${d}${automatic_rename}"
|
||||
done
|
||||
tmux list-windows -a -F "$(window_format)"
|
||||
}
|
||||
|
||||
dump_state() {
|
||||
tmux display-message -p "$(state_format)"
|
||||
}
|
||||
|
||||
dump_pane_contents() {
|
||||
local pane_contents_area="$(get_tmux_option "$pane_contents_area_option" "$default_pane_contents_area")"
|
||||
dump_panes_raw |
|
||||
while IFS=$d read line_type session_name window_number window_active window_flags pane_index pane_title dir pane_active pane_command pane_pid history_size; do
|
||||
capture_pane_contents "${session_name}:${window_number}.${pane_index}" "$history_size" "$pane_contents_area"
|
||||
dump_bash_history() {
|
||||
dump_panes |
|
||||
while IFS=$'\t' read line_type session_name window_number window_name window_active window_flags pane_index dir pane_active pane_command full_command; do
|
||||
save_shell_history "$session_name:$window_number.$pane_index" "$pane_command" "$full_command"
|
||||
done
|
||||
}
|
||||
|
||||
remove_old_backups() {
|
||||
# remove resurrect files older than 30 days (default), but keep at least 5 copies of backup.
|
||||
local delete_after="$(get_tmux_option "$delete_backup_after_option" "$default_delete_backup_after")"
|
||||
local -a files
|
||||
files=($(ls -t $(resurrect_dir)/${RESURRECT_FILE_PREFIX}_*.${RESURRECT_FILE_EXTENSION} | tail -n +6))
|
||||
[[ ${#files[@]} -eq 0 ]] ||
|
||||
find "${files[@]}" -type f -mtime "+${delete_after}" -exec rm -v "{}" \; > /dev/null
|
||||
}
|
||||
|
||||
save_all() {
|
||||
local resurrect_file_path="$(resurrect_file_path)"
|
||||
local last_resurrect_file="$(last_resurrect_file)"
|
||||
mkdir -p "$(resurrect_dir)"
|
||||
fetch_and_dump_grouped_sessions > "$resurrect_file_path"
|
||||
dump_panes >> "$resurrect_file_path"
|
||||
dump_windows >> "$resurrect_file_path"
|
||||
dump_state >> "$resurrect_file_path"
|
||||
execute_hook "post-save-layout" "$resurrect_file_path"
|
||||
if files_differ "$resurrect_file_path" "$last_resurrect_file"; then
|
||||
ln -fs "$(basename "$resurrect_file_path")" "$last_resurrect_file"
|
||||
else
|
||||
rm "$resurrect_file_path"
|
||||
dump_panes > $resurrect_file_path
|
||||
dump_windows >> $resurrect_file_path
|
||||
dump_state >> $resurrect_file_path
|
||||
ln -fs "$resurrect_file_path" "$(last_resurrect_file)"
|
||||
if save_bash_history_option_on; then
|
||||
dump_bash_history
|
||||
fi
|
||||
if capture_pane_contents_option_on; then
|
||||
mkdir -p "$(pane_contents_dir "save")"
|
||||
dump_pane_contents
|
||||
pane_contents_create_archive
|
||||
rm "$(pane_contents_dir "save")"/*
|
||||
fi
|
||||
remove_old_backups
|
||||
execute_hook "post-save-all"
|
||||
}
|
||||
|
||||
show_output() {
|
||||
[ "$SCRIPT_OUTPUT" != "quiet" ]
|
||||
restore_zoomed_windows
|
||||
}
|
||||
|
||||
main() {
|
||||
if supported_tmux_version_ok; then
|
||||
if show_output; then
|
||||
start_spinner "Saving..." "Tmux environment saved!"
|
||||
fi
|
||||
start_spinner "Saving..." "Tmux environment saved!"
|
||||
save_all
|
||||
if show_output; then
|
||||
stop_spinner
|
||||
display_message "Tmux environment saved!"
|
||||
fi
|
||||
stop_spinner
|
||||
display_message "Tmux environment saved!"
|
||||
fi
|
||||
}
|
||||
main
|
||||
|
|
|
|||
|
|
@ -1,15 +1,13 @@
|
|||
# key bindings
|
||||
default_save_key="C-s"
|
||||
default_save_key="M-s C-s"
|
||||
save_option="@resurrect-save"
|
||||
save_path_option="@resurrect-save-script-path"
|
||||
|
||||
default_restore_key="C-r"
|
||||
default_restore_key="M-r C-r"
|
||||
restore_option="@resurrect-restore"
|
||||
restore_path_option="@resurrect-restore-script-path"
|
||||
|
||||
# default processes that are restored
|
||||
default_proc_list_option="@resurrect-default-processes"
|
||||
default_proc_list='vi vim view nvim emacs man less more tail top htop irssi weechat mutt'
|
||||
default_proc_list='vi vim nvim emacs man less more tail top htop irssi'
|
||||
|
||||
# User defined processes that are restored
|
||||
# 'false' - nothing is restored
|
||||
|
|
@ -25,24 +23,8 @@ restore_processes=""
|
|||
restore_process_strategy_option="@resurrect-strategy-"
|
||||
|
||||
inline_strategy_token="->"
|
||||
inline_strategy_arguments_token="*"
|
||||
|
||||
save_command_strategy_option="@resurrect-save-command-strategy"
|
||||
default_save_command_strategy="ps"
|
||||
|
||||
# Pane contents capture options.
|
||||
# @resurrect-pane-contents-area option can be:
|
||||
# 'visible' - capture only the visible pane area
|
||||
# 'full' - capture the full pane contents
|
||||
pane_contents_option="@resurrect-capture-pane-contents"
|
||||
pane_contents_area_option="@resurrect-pane-contents-area"
|
||||
default_pane_contents_area="full"
|
||||
|
||||
# set to 'on' to ensure panes are never ever overwritten
|
||||
overwrite_option="@resurrect-never-overwrite"
|
||||
|
||||
# Hooks are set via ${hook_prefix}${name}, i.e. "@resurrect-hook-post-save-all"
|
||||
hook_prefix="@resurrect-hook-"
|
||||
|
||||
delete_backup_after_option="@resurrect-delete-backup-after"
|
||||
default_delete_backup_after="30" # days
|
||||
bash_history_option="@resurrect-save-bash-history"
|
||||
|
|
|
|||
|
|
@ -1,25 +0,0 @@
|
|||
#!/usr/bin/env bash
|
||||
|
||||
# "mosh-client default strategy"
|
||||
#
|
||||
# Example mosh-client process:
|
||||
# mosh-client -# charm tmux at | 198.199.104.142 60001
|
||||
#
|
||||
# When executed, the above will fail. This strategy handles that.
|
||||
|
||||
ORIGINAL_COMMAND="$1"
|
||||
DIRECTORY="$2"
|
||||
|
||||
mosh_command() {
|
||||
local args="$ORIGINAL_COMMAND"
|
||||
|
||||
args="${args#*-#}"
|
||||
args="${args%|*}"
|
||||
|
||||
echo "mosh $args"
|
||||
}
|
||||
|
||||
main() {
|
||||
echo "$(mosh_command)"
|
||||
}
|
||||
main
|
||||
|
|
@ -13,9 +13,18 @@ vim_session_file_exists() {
|
|||
[ -e "${DIRECTORY}/Session.vim" ]
|
||||
}
|
||||
|
||||
original_command_contains_session_flag() {
|
||||
[[ "$ORIGINAL_COMMAND" =~ "-S" ]]
|
||||
}
|
||||
|
||||
main() {
|
||||
if vim_session_file_exists; then
|
||||
echo "vim -S"
|
||||
elif original_command_contains_session_flag; then
|
||||
# Session file does not exist, yet the original vim command contains
|
||||
# session flag `-S`. This will cause an error, so we're falling back to
|
||||
# starting plain vim.
|
||||
echo "vim"
|
||||
else
|
||||
echo "$ORIGINAL_COMMAND"
|
||||
fi
|
||||
|
|
|
|||
|
|
@ -1,21 +0,0 @@
|
|||
pane 0 0 :bash 1 :* 0 :/tmp 1 bash :
|
||||
pane blue 0 :vim 0 : 0 :/tmp 1 vim :vim foo.txt
|
||||
pane blue 1 :man 0 :- 0 :/tmp 0 bash :
|
||||
pane blue 1 :man 0 :- 1 :/usr/share/man 1 man :man echo
|
||||
pane blue 2 :bash 1 :* 0 :/tmp 1 bash :
|
||||
pane red 0 :bash 0 : 0 :/tmp 1 bash :
|
||||
pane red 1 :bash 0 :-Z 0 :/tmp 0 bash :
|
||||
pane red 1 :bash 0 :-Z 1 :/tmp 0 bash :
|
||||
pane red 1 :bash 0 :-Z 2 :/tmp 1 bash :
|
||||
pane red 2 :bash 1 :* 0 :/tmp 0 bash :
|
||||
pane red 2 :bash 1 :* 1 :/tmp 1 bash :
|
||||
pane yellow 0 :bash 1 :* 0 :/tmp/bar 1 bash :
|
||||
window 0 0 1 :* ce9e,200x49,0,0,1
|
||||
window blue 0 0 : ce9f,200x49,0,0,2
|
||||
window blue 1 0 :- 178b,200x49,0,0{100x49,0,0,3,99x49,101,0,4}
|
||||
window blue 2 1 :* cea2,200x49,0,0,5
|
||||
window red 0 0 : cea3,200x49,0,0,6
|
||||
window red 1 0 :-Z 135b,200x49,0,0[200x24,0,0,7,200x24,0,25{100x24,0,25,8,99x24,101,25,9}]
|
||||
window red 2 1 :* db81,200x49,0,0[200x24,0,0,10,200x24,0,25,11]
|
||||
window yellow 0 1 :* 6781,200x49,0,0,12
|
||||
state yellow blue
|
||||
|
|
@ -1,21 +0,0 @@
|
|||
pane 0 0 :bash 1 :* 0 :/tmp 1 bash :
|
||||
pane blue 0 :vim 0 :! 0 :/tmp 1 vim :vim foo.txt
|
||||
pane blue 1 :man 0 :!- 0 :/tmp 0 bash :
|
||||
pane blue 1 :man 0 :!- 1 :/usr/share/man 1 man :man echo
|
||||
pane blue 2 :bash 1 :* 0 :/tmp 1 bash :
|
||||
pane red 0 :bash 0 : 0 :/tmp 1 bash :
|
||||
pane red 1 :bash 0 :-Z 0 :/tmp 0 bash :
|
||||
pane red 1 :bash 0 :-Z 1 :/tmp 0 bash :
|
||||
pane red 1 :bash 0 :-Z 2 :/tmp 1 bash :
|
||||
pane red 2 :bash 1 :* 0 :/tmp 0 bash :
|
||||
pane red 2 :bash 1 :* 1 :/tmp 1 bash :
|
||||
pane yellow 0 :bash 1 :* 0 :/tmp/bar 1 bash :
|
||||
window 0 0 1 :* ce9d,200x49,0,0,0
|
||||
window blue 0 0 :! cea4,200x49,0,0,7
|
||||
window blue 1 0 :!- 9797,200x49,0,0{100x49,0,0,8,99x49,101,0,9}
|
||||
window blue 2 1 :* 677f,200x49,0,0,10
|
||||
window red 0 0 : ce9e,200x49,0,0,1
|
||||
window red 1 0 :-Z 52b7,200x49,0,0[200x24,0,0,2,200x24,0,25{100x24,0,25,3,99x24,101,25,4}]
|
||||
window red 2 1 :* bd68,200x49,0,0[200x24,0,0,5,200x24,0,25,6]
|
||||
window yellow 0 1 :* 6780,200x49,0,0,11
|
||||
state yellow blue
|
||||
|
|
@ -1,42 +0,0 @@
|
|||
#!/usr/bin/env expect
|
||||
|
||||
source "./tests/helpers/expect_helpers.exp"
|
||||
|
||||
expect_setup
|
||||
|
||||
spawn tmux
|
||||
# delay with sleep to compensate for tmux starting time
|
||||
sleep 1
|
||||
|
||||
run_shell_command "cd /tmp"
|
||||
|
||||
# session red
|
||||
new_tmux_session "red"
|
||||
|
||||
new_tmux_window
|
||||
horizontal_split
|
||||
vertical_split
|
||||
toggle_zoom_pane
|
||||
|
||||
new_tmux_window
|
||||
horizontal_split
|
||||
|
||||
# session blue
|
||||
new_tmux_session "blue"
|
||||
|
||||
run_shell_command "touch foo.txt"
|
||||
run_shell_command "vim foo.txt"
|
||||
|
||||
new_tmux_window
|
||||
vertical_split
|
||||
run_shell_command "man echo"
|
||||
|
||||
new_tmux_window
|
||||
|
||||
# session yellow
|
||||
new_tmux_session "yellow"
|
||||
run_shell_command "cd /tmp/bar"
|
||||
|
||||
start_resurrect_save
|
||||
|
||||
run_shell_command "tmux kill-server"
|
||||
|
|
@ -1,70 +0,0 @@
|
|||
# a set of expect helpers
|
||||
|
||||
# basic setup for each script
|
||||
proc expect_setup {} {
|
||||
# disables script output
|
||||
log_user 0
|
||||
# standard timeout
|
||||
set timeout 5
|
||||
}
|
||||
|
||||
proc new_tmux_window {} {
|
||||
send "c"
|
||||
send "cd /tmp\r"
|
||||
sleep 0.2
|
||||
}
|
||||
|
||||
proc rename_current_session {name} {
|
||||
send "$"
|
||||
# delete existing name with ctrl-u
|
||||
send ""
|
||||
send "$name\r"
|
||||
sleep 0.2
|
||||
}
|
||||
|
||||
proc new_tmux_session {name} {
|
||||
send "TMUX='' tmux new -d -s $name\r"
|
||||
sleep 1
|
||||
send "tmux switch-client -t $name\r"
|
||||
send "cd /tmp\r"
|
||||
sleep 0.5
|
||||
}
|
||||
|
||||
proc horizontal_split {} {
|
||||
send "\""
|
||||
sleep 0.2
|
||||
send "cd /tmp\r"
|
||||
sleep 0.1
|
||||
}
|
||||
|
||||
proc vertical_split {} {
|
||||
send "%"
|
||||
sleep 0.2
|
||||
send "cd /tmp\r"
|
||||
sleep 0.1
|
||||
}
|
||||
|
||||
proc toggle_zoom_pane {} {
|
||||
send "z"
|
||||
sleep 0.2
|
||||
}
|
||||
|
||||
proc run_shell_command {command} {
|
||||
send "$command\r"
|
||||
sleep 1
|
||||
}
|
||||
|
||||
proc start_resurrect_save {} {
|
||||
send ""
|
||||
sleep 5
|
||||
}
|
||||
|
||||
proc start_resurrect_restore {} {
|
||||
send ""
|
||||
sleep 10
|
||||
}
|
||||
|
||||
proc clear_screen_for_window {target} {
|
||||
send "tmux send-keys -t $target C-l\r"
|
||||
sleep 0.2
|
||||
}
|
||||
|
|
@ -1 +0,0 @@
|
|||
../../lib/tmux-test/tests/helpers/helpers.sh
|
||||
|
|
@ -1,18 +0,0 @@
|
|||
#!/usr/bin/env expect
|
||||
|
||||
source "./tests/helpers/expect_helpers.exp"
|
||||
|
||||
expect_setup
|
||||
|
||||
spawn tmux
|
||||
# delay with sleep to compensate for tmux starting time
|
||||
sleep 1
|
||||
|
||||
start_resurrect_restore
|
||||
|
||||
# delete all existing resurrect save files
|
||||
run_shell_command "rm ~/.tmux/resurrect/*"
|
||||
|
||||
start_resurrect_save
|
||||
|
||||
run_shell_command "tmux kill-server"
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
# we want "fixed" dimensions no matter the size of real display
|
||||
set_screen_dimensions_helper() {
|
||||
stty cols 200
|
||||
stty rows 50
|
||||
}
|
||||
|
||||
last_save_file_differs_helper() {
|
||||
local original_file="$1"
|
||||
diff "$original_file" "${HOME}/.tmux/resurrect/last"
|
||||
[ $? -ne 0 ]
|
||||
}
|
||||
|
|
@ -1 +0,0 @@
|
|||
../lib/tmux-test/tests/run_tests_in_isolation
|
||||
|
|
@ -1,33 +0,0 @@
|
|||
#!/usr/bin/env bash
|
||||
|
||||
CURRENT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
|
||||
|
||||
source $CURRENT_DIR/helpers/helpers.sh
|
||||
source $CURRENT_DIR/helpers/resurrect_helpers.sh
|
||||
|
||||
setup_before_restore() {
|
||||
# setup restore file
|
||||
mkdir -p ~/.tmux/resurrect/
|
||||
cp tests/fixtures/restore_file.txt "${HOME}/.tmux/resurrect/restore_file.txt"
|
||||
ln -sf restore_file.txt "${HOME}/.tmux/resurrect/last"
|
||||
|
||||
# directory used in restored tmux session
|
||||
mkdir -p /tmp/bar
|
||||
}
|
||||
|
||||
restore_tmux_environment_and_save_again() {
|
||||
set_screen_dimensions_helper
|
||||
$CURRENT_DIR/helpers/restore_and_save_tmux_test_environment.exp
|
||||
}
|
||||
|
||||
main() {
|
||||
install_tmux_plugin_under_test_helper
|
||||
setup_before_restore
|
||||
restore_tmux_environment_and_save_again
|
||||
|
||||
if last_save_file_differs_helper "tests/fixtures/restore_file.txt"; then
|
||||
fail_helper "Saved file not correct after restore"
|
||||
fi
|
||||
exit_helper
|
||||
}
|
||||
main
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
#!/usr/bin/env bash
|
||||
|
||||
CURRENT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
|
||||
|
||||
source $CURRENT_DIR/helpers/helpers.sh
|
||||
source $CURRENT_DIR/helpers/resurrect_helpers.sh
|
||||
|
||||
create_tmux_test_environment_and_save() {
|
||||
set_screen_dimensions_helper
|
||||
$CURRENT_DIR/helpers/create_and_save_tmux_test_environment.exp
|
||||
}
|
||||
|
||||
main() {
|
||||
install_tmux_plugin_under_test_helper
|
||||
mkdir -p /tmp/bar # setup required dirs
|
||||
create_tmux_test_environment_and_save
|
||||
|
||||
if last_save_file_differs_helper "tests/fixtures/save_file.txt"; then
|
||||
fail_helper "Saved file not correct (initial save)"
|
||||
fi
|
||||
exit_helper
|
||||
}
|
||||
main
|
||||
Loading…
Reference in New Issue