Это зависит от человека страниц ... Традиционно, они были включены в разделе с примерами - но по какой - то причине , что, как правило , отсутствуют в человеко - страницах под Linux (и я полагаю , другие с помощью GNU команды - которые наиболее в эти дни). В Solaris, с другой стороны, почти на каждой man-странице есть раздел Пример, часто с несколькими примерами.
Если предположить, FSF / GNU долгое время не поощрял использование man
страниц и предпочитал, чтобы пользователи использовали информацию для документации. info
страницы , как правило, более всеобъемлющим , чем человек страниц, и , как правило , действительно включают в себя примеры. info
страницы также являются более «актуальными» - т.е. связанные команды (например, команды для поиска файлов) часто можно найти вместе.
Другая причина может заключаться в том, что GNU и его man
страницы используются во многих различных операционных системах, которые могут отличаться друг от друга (в конце концов, между разными дистрибутивами Linux существует множество различий). Предполагалось, что издатель добавил примеры, относящиеся к конкретной ОС / дистрибутиву, что, очевидно, редко делается.
Я бы также добавил, что man
страницы никогда не предназначались для «обучения начинающих». UNIX был разработан компьютерными экспертами (старый термин «хакеры») и предназначен для компьютерных экспертов. Таким образом, справочные страницы были созданы не для того, чтобы обучать новичка, а для того, чтобы быстро помочь компьютерному специалисту, который нуждался в напоминании о каком-то непонятном варианте или странном формате файла - и это отражается в том, как раздел справочной страницы.
man
-страницы, таким образом, предназначены как
- Краткий справочник, чтобы освежить вашу память; показывая, как должна вызываться команда, и перечисляя доступные опции.
- Глубокое и тщательное - и, как правило, очень техническое - описание всех аспектов команды. Это написано компьютерными экспертами, для коллег компьютерных экспертов.
- Список переменных и файлов среды (т.е. файлов конфигурации), используемых командой.
- Ссылки на другую документацию (например, книги) и другие
man
страницы - например. для формата файлов конфигурации и связанных / похожих команд.
Тем не менее, я очень согласен с вами, что на man
страницах должны быть примеры, так как они могут лучше объяснить использование, чем простое изучение самой страницы руководства. Очень плохие примеры, как правило, не доступны на man
страницах Linux ...
Пример части примера справочной страницы Solaris - zfs (1M):
(...)
ПРИМЕРЫ
Пример 1 Создание иерархии файловой системы ZFS
Следующие команды создают файловую систему с именем pool / home
и файловая система с именем pool / home / bob. Точка монтирования
/ export / home устанавливается для родительской файловой системы и является
автоматически наследуется дочерней файловой системой.
# zfs create pool / home
# zfs set mountpoint = / export / home pool / home
# zfs create pool / home / bob
Пример 2 Создание снимка ZFS
Следующая команда создает снимок с именем вчера.
Этот снимок монтируется по требованию в .zfs / snapshot
каталог в корне файловой системы pool / home / bob.
# zfs снимок пула / home / bob @ вчера
Пример 3 Создание и уничтожение нескольких снимков
Следующая команда создает снимки, названные вчера
pool / home и все его дочерние файловые системы. каждый
снимок монтируется по требованию в каталог .zfs / snapshot
в корне своей файловой системы. Вторая команда уничтожает
недавно созданные снимки.
# zfs снимок -r pool / home @ вчера
# zfs destroy -r pool / home @ вчера
SunOS 5.11 Последнее изменение: 23 июля 2012 г. 51
Команды системного администрирования zfs (1M)
Пример 4. Отключение и включение сжатия файловой системы.
Следующая команда отключает свойство сжатия для
(...)
Эта конкретная справочная страница содержит 16 (!) Таких примеров ... Слава Solaris!
(И я признаю, что сам следовал этим примерам вместо того, чтобы читать всю справочную страницу для этой команды ...)