documentation updates

This commit is contained in:
Tessa Nordgren 2019-03-28 20:07:08 +00:00
parent 972bef1dbf
commit b4394c67ed

View File

@ -1,22 +1,12 @@
crussh: a modern cssh replacement
=================================
# crussh: a modern cssh replacement
Backstory
---------
## What are this?
For anyone who needs to administrate clusters of many machines,
[clusterssh](http://sourceforge.net/projects/clusterssh/) has long been a
fallback for when the rest of your automation tools aren't working.
However, cssh has a number of deficiencies in modern environments:
- Doesn't play nice with window placement of modern window managers.
- Doesn't play nice with modern toolkits' copy and paste behaviour.
- Gets a bit screwy when there's more terminals than can fit on-screen.
- Doesn't support nice antialiased fonts.
crussh aims to be a simple replacement for cssh that corrects these
problems. It does so with the following features:
crussh aims to be a simple replacement for cssh with the following improvements:
- Uses a single window to hold multiple terminals.
- Intelligently tiles terminals to fit available window size.
@ -24,39 +14,56 @@ problems. It does so with the following features:
- Never resizes a terminal smaller than 80x24 characters.
- Uses GTK and the VTE widget to provide modern, anti-aliased terminals.
Install
-------
## Install
The install process is very simple on most distros:
- Install python2, python-gtk2, and python-vte.
- Clone and symlink to your bin dir.
* Install python2, python-gtk2, and python-vte.
* Clone and symlink to your bin dir:
```bash
git clone https://github.com/nergdron/crussh.git
ln -s crussh/crussh.py ~/bin/crussh
```
- Run "crussh HOST [HOST ...]"
Run ```crussh HOST [HOST ...]```
Usage Tips
----------
## Examples
Doing a clustered paste isn't completely obvious. The following methods will work:
Basic usage is covered via the builtin help, which you can get by running
```crussh -h```. This section covers some common use cases.
To connect to a list of hosts in a file:
```bash
crussh $(cat hostlist.txt)
```
To use a custom login name, public key, or other SSH client options:
```bash
crussh -l someuser -i ~/.ssh/myotherkey -- host [host ...]
```
To do something other than ssh, such as edit a bunch of files in parallel:
```bash
crussh -e nano *.txt
```
## Usage Tips
Doing a clustered paste isn't completely obvious. The following methods will
work, after making sure you're clicked into the text entry box at the bottom of
the window:
- middle click or shift-insert to paste the X11 selection buffer.
- control-shift-v to paste the GTK/GNOME clipboard.
Bugs & TODO
-----------
## Bugs & To Do
To see current issues, report problems, and see plans for features,
see the [crussh GitHub issues page](https://github.com/nergdron/crussh/issues).
Copyright and License
---------------------
## Copyright and License
crussh is copyright 2012-2016 by Tessa Nordgren <tessa@sudo.ca>.
crussh is copyright 2012-2019 by Tessa Nordgren <tessa@sudo.ca>.
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by