末日审判

Question

man通常不包含命令的示例，或者包含很少。

例如scp：

NAME
     scp — secure copy (remote file copy program)

SYNOPSIS
     scp [-12346BCpqrv] [-c cipher] [-F ssh_config] [-i identity_file] [-l limit] [-o ssh_option] [-P port]
         [-S program] [[user@]host1:]file1 ... [[user@]host2:]file2

很难理解将源文件和目标文件放在哪里，就像这样的文档一样。

通过一个例子和一些描述可以非常清楚和容易理解：

scp -r  user@source_machine:/user/Desktop user@remote_machine:/path/foo

压缩包如下：

NAME
       zip - package and compress (archive) files

SYNOPSIS
       zip  [-aABcdDeEfFghjklLmoqrRSTuvVwXyz!@$]  [--longoption  ...]  [-b path] [-n suffixes] [-t date] [-tt
       date] [zipfile [file ...]]  [-xi list]

谢谢，有例子zip -r foo.zip foo

我认为最常用的方式是zip将 A 放入 B，[zipfile [file ...]]也许说你也可以将 zip 文件与其他文件打包在一起（在非母语人士的视野中）。只有示例才能说明这一点。

所以我想知道是否有命令或工具可以向我展示命令的示例。

Answer 1

相当长一段时间，我找到了一些解决方案：

末日审判

• 需要：npm
• 网址：https://github.com/tldr-pages/tldr
• 命令：tldr tar

PS：tldr支持许多客户端（查看上述 repo 上的 readme）。特别是 go 客户端可以离线工作并提供所有平台的二进制文件：https://github.com/leighmcculloch/tldr/

欺骗

• 需要：python
• 网址：https://github.com/chrisallenlane/cheat
• 命令：cheat tar

例如

• 需要：python
• 网址：https://github.com/srsudar/eg
• 命令：eg tar

Answer 2

很不幸的是，不行。

文档由开发人员负责，因此他们有责任将示例包含在man页面中。有时他们会这样做，有时他们不会。例如，命令在其手册页中find有一个非常可爱和广泛的部分。EXAMPLES

提供示例的工具会很方便，但由于 Ubuntu 和 Linux 有数百万个命令/程序，开发这样的工具将是一项艰巨的工作，就像西西弗斯的水平一样。简单的方法是在线搜索您要运行的任何程序的使用示例。书籍也是非常方便的资源。许多关于 Linux、Unix、shell 脚本等的书籍 - 它们提供了很多示例，更重要的是使用上下文对于这些命令。

如果您认为某个特定工具的手册页应该包含（更多）示例，请向其维护人员或开发人员提交错误报告在启动板上或“上游”，或者更好的是，提交一个添加这些示例的补丁。