From 18534ec466b26f07ff90f6f0ad1673db76aa38ff Mon Sep 17 00:00:00 2001 From: Evgenia Sinichenkova Date: Tue, 13 Mar 2012 16:36:49 +0300 Subject: [PATCH] changed documentation/index.txt --- admin-basics/documentation/index.txt | 72 +++++++++++++++------------- 1 file changed, 38 insertions(+), 34 deletions(-) diff --git a/admin-basics/documentation/index.txt b/admin-basics/documentation/index.txt index 973e2ad..7688e4e 100644 --- a/admin-basics/documentation/index.txt +++ b/admin-basics/documentation/index.txt @@ -9,10 +9,12 @@ === Экранная документация === Почти все системы семейства UNIX, включая систему Linux, имеют экранную -документацию (man pages). Её тексты содержат документацию по системным +документацию. Её тексты содержат документацию по системным командам, ресурсам, конфигурационным файлам и т. д., а также могут быть выведены на экран в процессе работы. +==== Man ==== + Для доступа к экранной документации используется команда `man` (сокращение от manual). Каждая страница руководства посвящена одному объекту системы. Для того чтобы прочесть страницу руководства по программе, @@ -20,7 +22,7 @@ manual). Каждая страница руководства посвящена опции есть у команды `date`, вы можете ввести команду: ---------------------------------------------------------- -[user@localhost user]$ man date +$ man date ---------------------------------------------------------- Большинство экранной документации написано для пользователей, имеющих некоторое @@ -45,18 +47,6 @@ manual). Каждая страница руководства посвящена режима чтения описания команд `man` необходимо нажать на клавиатуре *q*. Команда `man man` выдаёт справку по пользованию самой командой `man`. -Другой источник информации о Linux и составляющих его программах -- справочная -подсистема `info`. Страница руководства, несмотря на обилие ссылок различного -типа, остаётся «линейным» текстом, структурированным только логически. -Документ `info` -- это настоящий гипертекст, в котором множество небольших -страниц объединены в дерево. В каждом разделе документа `info` всегда есть -оглавление, из которого можно перейти к нужному подразделу, а затем -вернуться обратно. Кроме того, info-документ можно читать и -как непрерывный текст, поэтому в каждом подразделе есть ссылки на предыдущий -и последующий подразделы. Перемещаться между страницами в `info` можно по команде -`info info`. Команда `info`, введённая без параметров, предлагает пользователю -список всех документов `info`, установленных в системе. - Документация в подавляющем большинстве случаев пишется на простом английском языке. Необходимость писать на языке, который будет более или менее понятен большинству пользователей, объясняется постоянным развитием Linux. @@ -72,19 +62,32 @@ manual). Каждая страница руководства посвящена руководства, для которых есть перевод, и `man` по умолчанию будет отображать их на русском языке. +==== Info ==== + +Другой источник информации о Linux и составляющих его программах -- справочная +подсистема `info`. Страница руководства, несмотря на обилие ссылок различного +типа, остаётся «линейным» текстом, структурированным только логически. +Документ `info` -- это настоящий гипертекст, в котором множество небольших +страниц объединены в дерево. В каждом разделе документа `info` всегда есть +оглавление, из которого можно перейти к нужному подразделу, а затем +вернуться обратно (ссылки для перемещения по разделам текста помечены `*`). +Для получения вспомогательной информации о перемещении по тексту используйте клавишу `h`. +Полное руководство `info` вызывается командой +`info info`. Команда `info`, введённая без параметров, предлагает пользователю +список всех документов `info`, установленных в системе. + === Документация по пакетам === -Основное место для хранения разнообразной документации, в основном на -английском языке, -- каталог `/usr/share/doc`. Особое внимание обратите -на `HOWTO` (от англ. how to -- «как сделать») -- собрание практических -рекомендаций по самым различным вопросам, связанным с использованием Linux. +Дополнительным источником информации об интересующей вас программе, +в основном на английском языке, является +каталог `/usr/share/doc` -- место хранения разнообразной документации. Каждый пакет также содержит поставляемую вместе с включённым в него ПО документацию, располагающуюся обычно в каталоге `/usr/share/doc/имя_пакета`. Например, документация к пакету `foo-1.0-alt1` находится в `/usr/share/doc/foo-1.0-alt1`. Для получения полного списка файлов документации, относящихся к -пакету, воспользуйтесь командой `rpm -qld имя_пакета`. +пакету, воспользуйтесь командой `rpm -qld имя_установленного_пакета`. В документации к каждому пакету вы можете найти такие файлы как `README`, `FAQ`, `TODO`, `СhangeLog` и другие. В файле `README` @@ -99,31 +102,32 @@ manual). Каждая страница руководства посвящена функциональности. В файле `СhangeLog` записана история изменений в программе от версии к версии. -Адреса сайтов в Интернет, посвящённых отдельным программным -продуктам, указаны в информационных заголовках -соответствующих пакетов, их можно получить с помощью команды -`rpm -qi имя_установленного_пакета`. +Для поиска внешней информации о программе, например, адреса сайта программы в +сети Интернет можно использовать команду `rpm -qi имя_установленного_пакета`. +В информационном заголовке соответствующего пакета, среди прочей информации, +будет выведена искомая ссылка. + +Возможно, будет полезно знать расположение собрания практических +рекомендаций по самым различным вопросам, связанным с использованием Linux. +Файлы `HOWTO` в формате HTML (от англ. how to -- «как сделать») каталога +`/usr/share/doc/HOWTO/` (при условии их наличия в системе) содержат +многообразную информацию о работе Linux-систем. === Документация к программам, имеющим графический интерфейс === -Каждая программа, имеющая графический интерфейс, сопровождается справочной -информацией, которую можно вызвать, щёлкнув кнопку *Справка* в меню программы. -Обычно, разделы меню *Справка* вариативны, но есть и обязательно присутствующая -информация: +Каждая программа, имеющая графический интерфейс, как правило, сопровождается справочной +информацией, вызваемой из меню программы. Обычно, это разделы меню *Справка*. -* основной раздел справки содержит встроенное руководство, ссылки на локальные +По обыкновению, это меню предоставляет информацию о программе, её версии, +лицензии и авторах. В большинстве случаев, справка содержит встроенное руководство, ссылки на локальные сведения и интернет-страницы документации на официальных сайтах программ (традиционная кнопка *F1*), информацию о сочетании клавиш, а также сообщения о процедурах и отладке в программе. -* раздел *О программе* предоставляет краткую информацию о программе, её версии, -лицензии и авторах. - === Документация к дистрибутиву === -В дистрибутив (DISTRO) входит комплект документации в печатном виде (если вы -приобрели дистрибутив в розницу) и в электронном виде (в формате HTML). В -документации к (DISTRO) вы найдёте сведения и рекомендации по установке и +В любой дистрибутив ALT Linux входит комплект документации в электронном виде (формат HTML). В +данной документации вы найдёте сведения и рекомендации по установке и настройке системы, а также обзор доступных прикладных программ и способов работы с ними. В случае установки по умолчанию, вся документация будет доступна через общесистемное меню *Документация* или по ссылке на рабочем