Будь-яка команда / інструмент для показу прикладу команди

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]

Завдяки цьому є exmaple zip -r foo.zip foo

Звичайний спосіб, на який я думаю, є " zipА" в "Б", [zipfile [file ...]]можливо, кажучи, ви можете також упакувати zipfile і з іншими файлами (у режимі невідомого динаміка). Тільки приклад може зробити це зрозумілим.

Тож мені цікаво, чи є команда чи інструмент може показати мені приклад команди.

command-line manpage

— Мітрил
джерело

Я не думаю, що є інший спосіб показати інший приклад, ніж гугл. Спробуйте ввести "command" --helpта побачити, чи це вирішує вашу проблему.

— Джеймс

@James Я щоразу в Google, коли зустрічав незнайомі команди, то знайшов приклад, який допоможе мені. Це небагато часу, я думаю, що це може бути набагато ефективнішим, якщо якась команда чи інструмент можуть показувати приклад безпосередньо.

— Мітрил

Ви точно можете використовувати, "command" --helpщоб побачити використання коду. Спробуйте ввести zip --helpта подивіться, що на ньому написано.

— Джеймс

@James Я знав, але зазвичай "command" --helpне допомагав би більше man command. Я не говорю про кожну команду, просто про головну команду, що широко використовується, (я знаю, що багато команд з невеликого проекту можна використовувати лише --help, треба гуляти), я лише згадую zipі, scpяк звичайну широко використовувану команду, наприклад. zip --helpне такий корисний, як man zip, ніякого прикладу немає.

— Мітрил

Я точно погоджуюся з @Serg. Інакше прикладів кодів не так багато.

— Джеймс

Відповіді:

Досить довго, і я знайшов кілька рішень:

tldr

потрібно: н / хв
URL: https://github.com/tldr-pages/tldr
команда: tldr tar

PS: tldrпідтримка багатьох клієнтів (перевірте readme на вище репо). Особливо клієнт Go може працювати в автономному режимі та надавати всі бінарні файли платформи: https://github.com/leighmcculloch/tldr/

обманювати

знадобиться: пітон
url: https://github.com/chrisallenlane/cheat
команда: cheat tar

напр

знадобиться: пітон
URL: https://github.com/srsudar/eg
команда: eg tar

— Мітрил
джерело

Пов'язана документація про клієнта GO не вказує на необхідність використання спеціальних інструментів GO, коли їх слід створювати з джерела. Ці інструменти не є частиною стандартної установки Ubuntu. Їх можна встановити за допомогою sudo apt install golang.

— CatMan

На жаль, немає.

Документація покладається на розробників, тому їх обов'язок включати приклади на manсторінки. Іноді вони роблять, інколи - ні. Наприклад, findкоманда має дуже симпатичний та обширний EXAMPLESрозділ на своїй довідковій сторінці.

Інструменти для надання прикладів були б корисними, але оскільки в цілому є мільйони команд / програм для Ubuntu та Linux, розробка такого інструменту буде значним зусиллям на рівні Сизіфа. Простий підхід - це просто пошук в Інтернеті прикладів використання будь-якої програми, яку ви намагаєтеся запустити. Книги також є дуже зручним ресурсом. Багато книг про Linux, Unix, сценарії оболонок тощо - вони надають безліч прикладів та важливіше використання контексту для цих команд.

Якщо ви вважаєте, що сторінка керівництва для певного інструменту повинна містити (більше) прикладів, будь-ласка, подайте звіт про помилку з його технічними розробниками чи розробниками на Launchpad або “upstream” або ще краще, надішліть виправлення, яке додає ці приклади.

— Сергій Колодяжний
джерело