Как исторически, так и сегодня, что было или является общепринятым аргументом по умолчанию для команды, чтобы показать свою страницу справки?

Исторически так сложилось, что память для программ была драгоценной, в ней не было места для всякой ерунды вроде «справочных» сообщений. Настоящие Unix-бородады знали программы наизусть, новички использовали man(1 ). Едва памяти для разумных сообщений об ошибках (печально известный "?" из ed (1 )для любая ошибка, копия (1 )только сообщение "синтаксическая ошибка в строке N" ). Когда память стала (более )обильной, некоторые программы начали принимать "-h" для помощи/инструкций по минимальному использованию. GNU представил длинные «--варианты» и часто «--помощь». Другие с «-u», или «-использование», или просто выплевывают справку для любой нераспознанной опции.

-h это очень старая конвенция . В системах DOS вы также часто встречали -?или /?.

Не слушайте людей, которые говорят, что man-страницы предназначены для новичков. Они очень ценны и уже добавлены в систему Unix в 1971 всего через 2 года после рождения Unix. Они были набраны с помощью troff уже в 1973 году. Он по-прежнему должен быть POSIX-совместимым (, но может быть псевдонимомinfo). У него очень долгая история , и жаль, что он не вызывает большего интереса в сегодняшнем помешанном на Интернете мире. Люди, которые ругают man-страницы или их пользователи, часто «забывают» (, не могут )создавать их сами. Документация важна .

К сожалению, справочные страницы не очень хорошо хранятся в Linux, поэтому многие пользователи считают их устаревшими. Но во FreeBSD (и, я думаю, в других BSD )они поддерживаются -до -даты и являются лучшим способом узнать как систему, так и команды.

Информация исходит из опыта работы с GNU в конце 1980-х годов и основана на гипертексте. Он распространен в системе Linux, но, к сожалению, не так хорошо интегрирован. Вы найдете много инструментов без информационных страниц.

--helpснова является GNU-измом и был представлен с длинными опциями в библиотеке GNU C в начале 90-х. Это более позднее соглашение -, но оно хорошо, если вы поддерживаете длинные опции.

Для меня хорошая программа выдала бы очень краткую сводку параметров командной строки, используя -h. Если ваша программа поддерживает длинные параметры, сделайте то же самое для --helpА затем поместите соответствующие инструкции на страницу руководства.

Однако это всего лишь условности. Но даже если вы не хотите следовать им -, я бы очень осторожно использовал -hдля чего-либо, кроме помощи. Или, по крайней мере, убедитесь, что это не -деструктивный параметр, такой как df -h.

Сегодня я бы написал справочную страницу в mdoc . Это довольно просто, и существует множество инструментов для их последующей обработки в уценку, PDF или HTML для использования в других местах.

Уместная цитата из mdoc

A utility without a manual is of no utility at all.