Страницы MAN
Материал из Gentoo Linux Wiki
[править] Введение
Документация к программному обеспечению зачастую более важна, чем само программное обеспечение, конечно если оно не используется только автором. Даже если я пишу программу, которую собираюсь использовать только сам, я все равно пишу документацию, потому, что через несколько месяцев можно забыть как использовать приложение, а хорошо написанная документация поможет мне за несколько секунд вспомнить это.
Традиционные утилиты ОС Linux обычно хорошо документированы. Если вы хотите узнать как работает программа - вам достаточно набрать: man commandname
Преимущество man-страниц перед другими формами документации состоит в следующем:
- Они доступны на любом терминале ОС Linux в любой момент времени;
- Их легко преобразовать в любой другой формат: HTML, PDF, Postscript, plain text, ...;
- man-страницы можно смотреть не только в терминальном режиме, но и в приложениях, например в konqueror (просто наберите: man:commandname или # commandname).
[править] Категории
Man-страницы собраны по разделам, примерно также как книги - по главам.
[править] Заголовочные файлы POSIX (0p)
[править] Программы и утилиты (Команды пользователя) (1)
[править] Утилиты POSIX (1p)
[править] Программы и утилиты X (1x)
[править] Системные вызовы (2)
[править] Подпрограммы (библиотечные функции ) (3)
[править] Функции POSIX (3p)
[править] Модули Perl (3pm) и perldoc(1)
Вместе с Perl поставляется большое количество документации. Hачиная с perlfaq(1), который желательно прочесть или хотя бы просмотреть заголовки.
Кроме этого поставляется программа perldoc: perldoc <имя_модуля> – описание для установленного модуля, perldoc -f <имя_функции> – описание функции, perldoc -q <строка> – поиск по FAQ'у: perldoc perldoc – тоже интересно :)
В большинстве статей документации есть примеры кода. Если с вашим дистрибутивом perl не поставляется perldoc(1) – выкиньте этот дистрибутив. Что еще можно найти в perldoc(1):
| *perl(1) - о Perl вообще; | *perldelta(1) - изменения; |
| *perlfaq(1) - Perl FAQ; | |
| *perltoc(1) - синтаксис языка; | *perltoc(1) - подробное оглавление ко всей документации; |
| *perldata(1) - типы данных; | *perlop(1) - операции Perl; |
| *perlre(1) - регулярные выражения; | *perlvar(1) - специальные переменные; |
| *perlsub(1) - функции (процедуры); | *perlmod(1) - модули; |
| *perlmodlib(1) - модули: создание собственных библиотек; | *perlmodinstall(1) - установка модулей CPAN; |
| *perlform(1) - форматы; | *perllocale(1) - локализация; |
| *perlref(1) - сcылки и указатели на данные; | *perldsc(1) - введение в структурные типы данных; |
| *perllol(1) - структуры данных: массивы и списки; | *perltoot(1) - учебник по объектно-ориентированному программированию; |
| *perlobj(1) - объекты в Perl; | *perltie(1) - связь объектов с обыкновенными переменными; |
| *perlbot(1) - Perl OO tricks и примеры; | *perlipc(1) - связь между процессами; |
| *perldebug(1) - отладка программ; | *perldiag(1) - сообщения об ошибках; |
| *perlsec(1) - вопросы безопасности; | *perlembed(1) - способы внедрения Perl-программ в программы на C/C++; |
| *perlapio(1) - собственный API, использумый в исходниках Perl; | *perlxs(1) - XS программирование Perl-библиотек, используемых вместе с библиотеками на C; |
| *perlxstut(1) - учебник по XS; | *perlguts(1) - внутренние функции Perl для разработчиков; |
| *perlcall(1) - соглашения о вызове Perl-функций из C; | *perlhist(1) - история и полный список всех версий Perl; |
| *perlbook(1) - книги; | *lwpcook(1) - «Поваренная книга» LWP; |
[править] Устройства (4)
[править] Форматы файлов (5)
[править] Игры (6)
[править] Разное (7)
[править] Системное администрирование (8)
[править] Ядро (9)
| *aio(9) | *ata(9) | *events(9) | *kacpid(9) | *kblockd(9) | *khelper(9) | *khubd(9) |
| *kswapd(9) | *kseriod(9) | *ksoftirqd(9) | *migration(9) | *pdflush(9) | *reiserfs(9) | *scsi_eh(9) |
[править] Новая документация (n)
В основном описывает язык программирования TCL.
