Skip to content

Commit

Permalink
readme md
Browse files Browse the repository at this point in the history
  • Loading branch information
sk1418 committed Jun 10, 2017
1 parent 6162ece commit a553957
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

- A tmux session backup/reload tool

####Table of contents
#### Table of contents
(toc generated by [ghtoc](https://github.com/sk1418/ghtoc))
- [Introduction](#introduction)
- [Features](#features)
Expand All @@ -18,7 +18,7 @@
- [Installation](#installation)
- [Usage](#usage)

##Introduction
## Introduction
Tmux is very handy tool. However we cannot persist the sessions and reload them later. We want to restore our sessions in some situations. E.g. when we have to reboot the machine or we want to "clone" all sessions from a machine to another.

**retmux** comes to try to solve this problem. It makes tmux backup and restore easily to be done. You can manage your tmux backups with **retmux** and get your sessions back.
Expand All @@ -27,41 +27,41 @@ Tmux is very handy tool. However we cannot persist the sessions and reload them
- python 2.7.6
- tmux 1.8

##Features
## Features

- configurable options for (logging, ANSI escapes)
- (non- or) interactive operations (list/delete/restore/backup)
- highlighted output
- most important: tmux sessions backup and restore :)

###What can be backed up/restored?
### What can be backed up/restored?
- **sessions** : with names, terminal-size
- **windows** : with name, order, pane split and split layout
- **panes** : with path and content(up to 100000 line history content) with same look and feel (ANSI escapes)

###What would NOT be backed up/restored?
### What would NOT be backed up/restored?
- the processes/programs running in window or pane at backup time
- the logined user, if the user is not same as the user who started tmux.(e.g. after `su`)
- command history in each window
- buffer stacks (could be done, but didn't see the need)

##Example & Screenshots & Demo
## Example & Screenshots & Demo

- `retmux -h` output
![help view](https://raw.github.com/sk1418/sharedResources/master/retmux/retmux_help.png)

- show detail of a tmux backup
![detail view](https://raw.github.com/sk1418/sharedResources/master/retmux/retmux_details.png)

##Installation
## Installation

- for Archlinux user, `retmux` is available in AUR. If you want to try the development version, install the `retmux-git` package.
- for other users:
- checkout the `master` branch for stable release version, checkout `bleeding` branch for development version, then

sudo python setup.py install

##Usage
## Usage

see the first screenshot in the `screenshots` section

Expand Down

0 comments on commit a553957

Please sign in to comment.