tldr:为生物软件添加一个中文注释

文摘   2025-01-17 10:24   辽宁  
新手对于Linux命令行不熟悉,不会查看帮助文档,tldr项目就是为了给命令行添加一个更容易理解的帮助文档,辅助大家更好的使用命令行。而且该项目还包括很多生物软件的文档。



tldr-pages项目

其实Linux的命令行都有帮助文档,可以通过--help,info,以及man命令来查看详细的文档。但是对于新手一是不会查看帮助,而是不熟悉英文文档,又不会或者不愿意搜索。如果满足以上三点,就可以使用这个项目。



但实际上这又是一个悖论,如果能把这个正确配置成功了,应该也会查看帮助了。

项目地址:https://github.com/tldr-pages/tldr?tab=readme-ov-file

其中TL;DR 代表 "Too Long; Didn't Read".也就是文档太长了,不想看,当你忘记哪个项目时,记得这个就行。类似的项目还有不少。

安装使用

安装有多种方法,这里我们试用pip来安装。

pip3 install tldr

安装完成之后就可以直接手机用tldr来查看帮助信息。

tldr tar

tar

Archiving utility. Often combined with a compression method, such as `gzip` or `bzip2`. More information: https://www.gnu.org/software/tar.

- [c]reate an archive and write it to a [f]ile: tar cf path/to/target.tar path/to/file1 path/to/file2 ...

- [c]reate a g[z]ipped archive and write it to a [f]ile: tar czf path/to/target.tar.gz path/to/file1 path/to/file2 ...

默认是英文,可以通过-L参数设置为中文。

$ tldr -L zh tar

tar

归档实用程序。 通常与压缩方法结合使用,例如 `gzip``bzip2`. 更多信息:https://www.gnu.org/software/tar.

- 创建存档并将其写入文件: tar cf 目标文件.tar 路径/到/文件1 路径/到/文件2 ...

- 创建一个 gzip 压缩文件并将其写入文件: tar czf 目标文件.tar.gz 路径/到/文件1 路径/到/文件2 ...

- 使用相对路径从目录创建一个 gzip 压缩文件: tar czf 目标文件.tar.gz --directory=路径/到/目录 .

设置中文

如果想每次默认就是中文,而不是用-L选项,可以设置环境变量,将

export TLDR_LANGUAGE="zh"

添加到bash中,这样默认就是中文帮助信息。

设置缓存

由于每次需要联网检索,这样速度会很慢,而且如果网络不好还容易报错。可以将数据库都下载下来,大大提高检索速度,定期更新。软件原理其实并不难,就是有人写好了这些材料,主要是一些markdown文档,搜索匹配即可。

 $ tldr -uUpdated cache for language zh: 917 entriesUpdated cache for language en: 5441 entries

目前已经有超过917个中文命令,5441个英文,足够用了。我们做生物信息只需要数量掌握30个就够了。

基因学苑
生物云计算专家
 最新文章