用于显示命令示例的任何命令/工具

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

我认为正常的方式是将A zip成B， [zipfile [file ...]]可能会说你也可以将zipfile与其他文件一起打包（在非本地人的视觉上）。 只有这个例子可以说清楚。

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

Answer 1

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

tldr

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

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

作弊

• 需要：python
• url： https ： //github.com/chrisallenlane/cheat
• 命令： cheat tar

例如

• 需要：python
• url： https ： //github.com/srsudar/eg
• 命令： eg tar

Answer 2

很不幸的是，不行。

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

提供示例的工具将非常方便，但由于Ubuntu和Linux通常有数百万个命令/程序，因此在Sisyphus级别上开发此类工具将是一项相当大的工作。 简单的方法是在线搜索您尝试运行的程序的使用示例。 书籍也是非常方便的资源。 许多关于Linux，Unix，shell脚本等的书籍 – 它们提供了许多示例，更重要的是这些命令的使用上下文 。

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