Usr share doc linux

Linux.yaroslavl.ru

Кроме руководств, поставляемых с Mandrake Linux , документацию можно получить из многих источников. Следующие несколько страниц предложат вам несколько советов, которые могут оказаться вам полезными.

Документация, поставляемая с Mandrake Linux

Собственная Документация Mandrakesoft

В этом разделе будет представлен список всей документации, которая создается в MandrakeSoft :

• Наши обновленные онлайновые версии ищите на: http://www.mandrakelinux.com/ru/fdoc.php3 Если во время инсталляции вы выбрали группу документации, тогда зайдите в Меню Mandrake, Документация и здесь вы найдете всю документацию на всех языках, которые вы выбрали в процессе инсталляции.
• Руководство по Быстрому Запуску; Этот документ в печатном виде поставляется в коробочной версии Mandrake Linux . Он служит справочником, облегчающим процесс инсталляции.
• Стартовое Руководство Пользователя; Это руководство предназначено для того, чтобы глубже познакомить вас с Mandrake Linux . В нем содержатся расширенные инструкции по установке и процедурам настройки основных элементов.
• Руководство по Командной Строке; Доступное только он-лайн и на CD, это руководство затрагивает вопросы расширенной работы в Linux и системного администрирования.
• Руководство по Ежедневным Приложениям; В этом руководстве рассказывается о приложениях, таких как OpenOffice.org, Gnumeric, утилитах Internet (X-Chat, Gaim), и других.
• Руководство по Быстрой Настройке Сервера; Здесь рассматриваются такие популярные сервисы, как HTTP, FTP, POP, SMTP, которые доступны в Linux. Этот документ также доступен только в он-лайн и на CD.

Страницы Руководства

Они являются первичным источником получения информации на каждый день. Все, или почти все, команды имеют соответствующие им страницы руководств. Некоторые конфигурационные файлы, функции библиотек для программистов и другие также имеют свои собственные страницы руководств.

Их содержимое располагается по различным секциям. Ссылки на эти секции сделаны следующим образом: например, open(2), fstab(5) соответственно ссылаются на страницу open в разделе 2 и страницу fstab в разделе 5.

Чтобы почитать страницу руководства, напишите man. Синтаксис команды следующий:

Для самой man доступна команда: man man. Страницы руководств форматированы и по умолчанию отображаются с помощью пейджераless.

Названия страниц руководств и относящихся к ним разделов отображаются в начале каждой страницы. В конце даются ссылки на другие разделы, имеющие отношение к теме (в общем случае это раздел SEE ALSO ).

Вы можете начать с изучения страниц, относящихся к различным командам, которые встречаются в этом руководстве: ls(1), chmod(1), и т.д.

Если вы не можете найти подходящую станицу руководства, например, вы хотите использовать в одной из своих программ функцию mknod, но застряли на странице команды mknod, тогда проверьте, правильно ли вы указали раздел. В нашем примере: mknod(2). Если вы забыли, как правильно указать раздел, тогда man -a mknod пробежится по всем разделам и поищет страницы с названием mknod.

Страницы Info

Страницы info дополняют документацию, включенную в страницы руководств. Команда для доступа к страницам info это info.

Страницы info имеют древовидную структуру, верхушка которой называется dir. С этого места вы можете добраться до любой из страниц info.

Страницы info могут вызываться двумя способами: либо опуская любой аргумент, при этом вы попадете в самый верх древовидной структуры, либо добавлением имени команды или пакета, при этом будет открыта соответствующая страница, если она существует. Например:

будет показывать ссылку. Перемещение курсора на эту ссылку (используя клавиши со стрелками) и нажатие Enter приведет вас к нужной странице info.

Вы можете использовать следующие сочетания клавиш:

• u: это Up (вверх), переместит вас на один уровень выше;
• n: это Next (Далее), для перехода на следующую страницу info на том же самом уровне древовидной структуры;
• p: это Prev (Назад), вернет вас на предыдущую страницу info.

Список множества команд можно получить, написав “?”.

HOWTOs

HOWTOs, опубликованные проектом TLDP (The Linux Documentation Project) и доступные на многих языках, помогут вам настроить многие аспекты вашей системы. Если установлен нужный пакет (пакет howto-html-en для английской версии), HOWTOs предоставит вам ответы на специфические вопросы или решения проблем. Документация размещается в каталоге /usr/share/doc/HOWTO/HTML/en/. Поставляется преимущественно в текстовых файлах, хотя их можно читать и в HTML с помощью браузера, и печатать с помощью PostScript.

Список файлов HOWTOs весьма внушительный. Советуем ознакомиться с его индексом, зайдя в главное меню: Документация->Английские HOWTOs. Если вы столкнулись со сложной проблемой, начните с чтения соответствующего HOWTO (если он есть, конечно!). Вы найдете не только решение своей проблемы, но к тому же узнаете много нового. Среди других, можно привести такие полезные документы, как сетевые вопросы (NET-3-HOWTO), настройка звуковой карты (Sound-HOWTO), запись носителей CD (CD-Writing-HOWTO), а также настройка NIS и NFS.

Важным шагом является проверка даты документов HOWTO, то есть даты публикации документа, которая приводится в начале каждого документа, для того, чтобы удостовериться, что документ еще не устарел. Иначе содержимое документа может быть неверным. Остерегайтесь устаревших HOWTOs, в особенности касающихся настройки оборудования, так как Linux развивается очень быстро в этой области. Помните также, что в мире свободного ПО значение “устаревший” имеет значительно больший вес, чем в области IT вообще: свободное ПО может рассматриваться как устаревшее уже через две недели после выхода!

Замечание

HOWTOs доступны в сети на web-сайте TLDP и там они практически всегда самые новые. Взгляните также и сюда: HOWTOs , классифицированные по категориям; и FAQs (ЧАсто задаваемые ВОпросы).

Каталог /usr/share/doc

Некоторые пакеты поставляются со своей собственной документацией, которая хранится в одном из каталогов, названном по имени пакета, в каталоге /usr/share/doc.

Источник

How to find out what a Linux command does

Learn how to locate, read, and use Linux system documentation with man, info, and /usr/share/doc files.

Linux distributions contain three powerful sets of documentation to enable users and administrators to get the most out of the system. Knowing how to use these resources effectively is an essential skill for Linux users.

Training & certification

Here are the three documentation sets:

The man pages

Man pages are the go-to resource for nearly every Linux user working at the command line.

What can you discover via the man pages?

• The command’s summary
• Options and explanations
• Examples
• Author and maintainer

This is perfect for when you cannot recall less commonly used options or work on multiple operating system platforms daily (the options between Linux and Unix versions of commands often differ).

Using the man pages is straightforward; simply type the man command and include the command you need more information about. For example, to display the manual for the ls command, type man ls .

Man pages include a powerful set of search capabilities to help you find exactly what you need. Once the man page is displayed, type a forward slash (/) to enable keyword searching. Simply enter the word you’re looking for after the slash and select Enter. Use the n and N keys to find the next or previous example of the keyword. Use Ctrl+C to end the search.

Man pages are organized into the following sections:

• User commands (section 1)
• System calls (section 2)
• C library functions (section 3)
• Devices and special files (section 4)
• File formats and conventions (section 5)
• Games (section 6)
• Miscellanea (section 7)
• System administration tools and daemons (section 8)

Typically, a request for a man page goes to section 1 or 8, but you can specify the section (assuming the requested command exists in multiple sections) by typing:

Comfort with accessing man pages and defining keyword searches is an essential Linux user skill. In fact, system documentation in general, and man pages specifically, are called out in the Red Hat Certified System Administrator (RHCSA) exam objectives.

[ See how your operating system is the foundation that solidifies and unifies your IT infrastructure in Why the operating system matters. ]

The info command

The info pages play a similar role to man pages, though they tend to be a little more user-friendly. The man pages are basically a short, terse reference, while info pages tend more toward readability and deeper explanations. The info page system also supports basic linking between documents for easier cross-referencing. This provides a more structured and readable documentation set.

The syntax for info pages is the same as with man :

Documentation

More formal documentation, along with templates, tutorials, licenses, and some configuration files, is found at /usr/share/doc . The files provide significantly more detail than man pages. These package-specific files are usually compressed, but tools such as vim and less handle the content seamlessly.

[ Learn more about Linux in the free training course Red Hat Enterprise Linux Technical Overview. ]

You can see what documentation is available by typing:

Each package has its own subdirectory. Run the following command to see the documentation for the Nano text editor:

The challenge

To help you practice using these resources, I’ve included three simple challenges involving the Nano text editor (so make sure Nano is installed before accomplishing these). The answer key is at the end of the article if you need it.

Great Linux resources

Wrap up

Not all systems are internet-connected, and not all reminders need to come from advanced Google searches. Sometimes all a sysadmin needs is a quick hint, «Oh yeah, that’s the option for long format.» Man pages are great for those short prompts. Info pages add more detail, better linking between resources, and more readability. The official documentation stored at /usr/share/doc provides the most depth, examples, templates, license information, and other relevant resources.

Источник