Skip to content

Commit

Permalink
update introduction
Browse files Browse the repository at this point in the history
  • Loading branch information
lonnywong committed Jan 20, 2024
1 parent 7353135 commit 967c4d8
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 13 deletions.
2 changes: 1 addition & 1 deletion cn/go.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ description: trzsz ( trz / tsz ) 是一个兼容 tmux 的文件传输工具,
[![GitHub Release](https://img.shields.io/github/v/release/trzsz/trzsz-go)](https://github.com/trzsz/trzsz-go/releases)
[![GitHub trzsz-go](https://img.shields.io/badge/GitHub-https%3A%2F%2Fgithub.com%2Ftrzsz%2Ftrzsz--go-blue?style=flat)](https://github.com/trzsz/trzsz-go)

`trzsz-go` 使所有支持本地 shell 的终端都支持 [trzsz](https://trzsz.github.io/cn/) ( trz / tsz ),和 lrzsz ( rz / sz ) 类似的、兼容 tmux 的文件传输工具
`trzsz-go` 使所有支持本地 shell 的终端都支持 [trzsz](https://trzsz.github.io/cn/) ( trz / tsz ) —— 和 rz / sz 类似、兼容 tmux 。

⭐ 推荐在服务器上使用 `go``trzsz ( trz / tsz )`

Expand Down
8 changes: 4 additions & 4 deletions cn/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,19 @@ description: trzsz ( trz / tsz ) 是一个兼容 tmux 的文件传输工具,

## 如何使用

1. 在服务器上安装 trzsz ( trz / tsz ),有 [go](https://github.com/trzsz/trzsz-go)[py](https://github.com/trzsz/trzsz)[js](https://github.com/trzsz/trzsz.js) 三种实现,互相兼容。
1. 在服务器上安装 `trzsz` ( trz / tsz ),有 [go](https://github.com/trzsz/trzsz-go)[py](https://github.com/trzsz/trzsz)[js](https://github.com/trzsz/trzsz.js) 三种实现,互相兼容。

2. 本地要使用支持的终端,有本地 shell 的终端可以使用 [trzsz-ssh ( tssh )](https://github.com/trzsz/trzsz-ssh),或参考下文【支持的终端】。

3. 使用 `trz` ( 类似 `rz` ) 命令上传文件,使用 `tsz` ( 类似 `sz` ) 命令下载文件。

## 为什么做

考虑 `laptop -> hostA -> hostB -> docker -> tmux` 这种场景,使用 `scp``sftp` 是不方便的。
- 考虑 `laptop -> hostA -> hostB -> docker -> tmux` 这种场景,使用 `scp``sftp` 是不方便的。

在这种场景下,使用 `lrzsz` ( rz / sz ) 是很方便的,但是很可惜它与 `tmux` 不兼容。
- 在这种场景下,使用 `lrzsz` ( rz / sz ) 是很方便的,但是很可惜它与 `tmux` 不兼容。

`tmux` 不愿意支持 rz / sz ( [906](https://github.com/tmux/tmux/issues/906), [1439](https://github.com/tmux/tmux/issues/1439) ),而重新造一个工具比修改 `tmux` 简单很多
- `tmux` 不打算支持 rz / sz ( [906](https://github.com/tmux/tmux/issues/906), [1439](https://github.com/tmux/tmux/issues/1439) ),于是就开发了 `trzsz` ( trz / tsz )

## 优点介绍

Expand Down
2 changes: 1 addition & 1 deletion cn/js.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ description: trzsz ( trz / tsz ) 是一个兼容 tmux 的文件传输工具,
[![npmjs trzsz](https://img.shields.io/npm/v/trzsz.svg?style=flat)](https://www.npmjs.com/package/trzsz)
[![GitHub trzsz.js](https://img.shields.io/badge/GitHub-https%3A%2F%2Fgithub.com%2Ftrzsz%2Ftrzsz.js-blue?style=flat)](https://github.com/trzsz/trzsz.js)

`trzsz.js` 使 webshell 和用 electron 开发的终端支持 [trzsz](https://trzsz.github.io/cn/) ( trz / tsz ),和 lrzsz ( rz / sz ) 类似的、兼容 tmux 的文件传输工具
`trzsz.js` 使 webshell 和用 electron 开发的终端支持 [trzsz](https://trzsz.github.io/cn/) ( trz / tsz ) —— 和 rz / sz 类似、兼容 tmux 。

_有关 `trzsz ( trz / tsz )` 更详细的文档,请查看 [https://trzsz.github.io/cn](https://trzsz.github.io/cn/)_

Expand Down
2 changes: 1 addition & 1 deletion go.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ layout: default

⭐ It's recommended to use the go version of `trzsz ( trz / tsz )` on the server.

_Please check [https://trzsz.github.io](https://trzsz.github.io) for more information of `trzsz ( trz / tsz )`._
_Please check [https://trzsz.github.io](https://trzsz.github.io) for more information about `trzsz ( trz / tsz )`._

## Installation

Expand Down
10 changes: 5 additions & 5 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,19 @@ layout: default

## How to use

1. Install trzsz ( trz / tsz ) on the server. [go](https://github.com/trzsz/trzsz-go), [py](https://github.com/trzsz/trzsz) and [js](https://github.com/trzsz/trzsz.js) versions are compatible with each other.
1. Install `trzsz` ( trz / tsz ) on the server. [go](https://github.com/trzsz/trzsz-go), [py](https://github.com/trzsz/trzsz) and [js](https://github.com/trzsz/trzsz.js) versions are compatible with each other.

2. Use supported terminal on local. Terminals with local shell can use [trzsz-ssh ( tssh )](https://github.com/trzsz/trzsz-ssh), or refer to `Supported Terminals` below.
2. Use supported terminal on local. Use [trzsz-ssh ( tssh )](https://github.com/trzsz/trzsz-ssh) on local shell, or refer to `Supported Terminals` below.

3. Use the `trz` ( similar to `rz` ) command to upload files, and use the `tsz` ( similar to `sz` ) command to download files.

## Why to do

Considering `laptop -> hostA -> hostB -> docker -> tmux`, using `scp` or `sftp` is inconvenience.
- Considering `laptop -> hostA -> hostB -> docker -> tmux`, using `scp` or `sftp` is inconvenience.

In this case, `lrzsz` ( rz / sz ) is convenient to use, but unfortunately it's not compatible with `tmux`.
- In this case, `lrzsz` ( rz / sz ) is convenient to use, but unfortunately it's not compatible with `tmux`.

`tmux` is not going to support rz / sz ( [906](https://github.com/tmux/tmux/issues/906), [1439](https://github.com/tmux/tmux/issues/1439) ), and creating a new tools is much easier than patching `tmux`.
- `tmux` is not going to support rz / sz ( [906](https://github.com/tmux/tmux/issues/906), [1439](https://github.com/tmux/tmux/issues/1439) ), so `trzsz` ( trz / tsz ) was developed.

## Advantage

Expand Down
2 changes: 1 addition & 1 deletion js.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ layout: default

`trzsz.js` makes terminal built with electron and webshell to support [trzsz](https://trzsz.github.io/) ( trz / tsz ), which similar to ( rz / sz ), and compatible with tmux.

_Please check [https://trzsz.github.io](https://trzsz.github.io) for more information of `trzsz ( trz / tsz )`._
_Please check [https://trzsz.github.io](https://trzsz.github.io) for more information about `trzsz ( trz / tsz )`._

## Getting Started

Expand Down

0 comments on commit 967c4d8

Please sign in to comment.