получение синопсиса inline [dубликат]

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

И как zip: [ ! d4] 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 A в B, [zipfile [file ...]] может сказать, что вы можете также упаковать zipfile и с другими файлами ( на видение без носителей). Только этот пример может сделать это.

Так что я задаюсь вопросом, есть ли команда или инструмент, который может показать мне пример команды.

1
задан 24 August 2016 в 06:01

4 ответа

Довольно долгое время, и я нашел некоторые решения:

tldr

need: npm url: https://github.com/tldr-pages/tldr команда: tldr tar

PS: tldr поддерживают многие клиенты (проверьте readme на вышепереписном репо). В частности, клиент go может работать в автономном режиме и предоставлять все бинарные файлы платформы: https://github.com/leighmcculloch/tldr/

https://github.com/leighmcculloch/tldr/

cheat

need: npm url: https://github.com/chrisallenlane/cheat url: https: // github. com / tldr-pages / tldr

eg

url: https://github.com/chrisallenlane/cheat url: https://github.com/tldr-pages/tldr команда: tldr tar

5
ответ дан 17 July 2018 в 20:10

Довольно долгое время, и я нашел некоторые решения:

tldr

need: npm url: https://github.com/tldr-pages/tldr команда: tldr tar

PS: tldr поддерживают многие клиенты (проверьте readme на вышепереписном репо). В частности, клиент go может работать в автономном режиме и предоставлять все бинарные файлы платформы: https://github.com/leighmcculloch/tldr/

https://github.com/leighmcculloch/tldr/

cheat

need: npm url: https://github.com/chrisallenlane/cheat url: https: // github. com / tldr-pages / tldr

eg

url: https://github.com/chrisallenlane/cheat url: https://github.com/tldr-pages/tldr команда: tldr tar

5
ответ дан 23 July 2018 в 20:54
[D0] К сожалению, нет.

Документация зависит от разработчиков, поэтому их ответственность заключается в том, чтобы включать примеры на страницы man. Иногда они это делают, иногда они этого не делают. Например, команда find имеет очень милую и обширную секцию EXAMPLES на странице руководства.

Инструменты для предоставления примеров были бы удобны, но поскольку в Ubuntu и Linux есть миллионы команд / программ общее развитие такого инструмента было бы значительным усилием на уровне Сизифа. Простой подход - это просто поиск в Интернете для использования примеров любой программы, которую вы пытаетесь запустить. Книги также очень полезны.

Если вы считаете, что страница руководства для конкретного инструмента должна содержать (более) примеры, пожалуйста, напишите отчет об ошибках со своими разработчиками или разработчиками на Launchpad или «вверх по течению» или, еще лучше, отправьте патч, который добавит эти примеры.

2
ответ дан 17 July 2018 в 20:10
[D0] К сожалению, нет.

Документация зависит от разработчиков, поэтому их ответственность заключается в том, чтобы включать примеры на страницы man. Иногда они это делают, иногда они этого не делают. Например, команда find имеет очень милую и обширную секцию EXAMPLES на странице руководства.

Инструменты для предоставления примеров были бы удобны, но поскольку в Ubuntu и Linux есть миллионы команд / программ общее развитие такого инструмента было бы значительным усилием на уровне Сизифа. Простой подход - это просто поиск в Интернете для использования примеров любой программы, которую вы пытаетесь запустить. Книги также очень полезны.

Если вы считаете, что страница руководства для конкретного инструмента должна содержать (более) примеры, пожалуйста, напишите отчет об ошибках со своими разработчиками или разработчиками на Launchpad или «вверх по течению» или, еще лучше, отправьте патч, который добавит эти примеры.

2
ответ дан 23 July 2018 в 20:54

Другие вопросы по тегам:

Похожие вопросы: