Chapter 50. Help and Documentation

Contents

50.1. Using the SUSE Help Center
50.2. Man Pages
50.3. Info Pages
50.4. The Linux Documentation Project
50.5. Wikipedia: The Free Online Encyclopedia
50.6. Guides and Books
50.7. Package Documentation
50.8. Usenet
50.9. Standards and Specifications

Abstract

SUSE Linux Enterprise® comes with various sources of information and documentation. The SUSE Help Center provides central access to the most important documentation resources on your system in searchable form. These resources include online help for installed applications, manual pages, info pages, databases on hardware and software topics, and all manuals delivered with your product.

50.1. Using the SUSE Help Center

When you start the SUSE Help Center for the first time from the main menu (SuSE Help Center) or with the command susehelp in the shell, a window as shown in Figure 50.1, “The Main Window of the SUSE Help Center” is displayed. The dialog window consists of three main areas:

Menu Bar and Toolbar

The menu bar provides the main editing, navigation, and configuration options. File contains the option for printing the currently displayed content. Under Edit, access the search function. Go contains all navigation possibilities: Table of Contents (home page of the Help Center), Back, Forward, and Last Search Result. With Settings+Build Search Index, generate a search index for all selected information sources. The toolbar contains three navigation icons (forward, back, home) and a printer icon for printing the current contents.

Navigation Area with Tabs

The navigation area in the left part of the window provides an input field for a quick search in selected information sources. Details regarding the search and the configuration of the search function in the Search tab are presented in Section 50.1.2, “The Search Function”. The Contents tab presents a tree view of all available and currently installed information sources. Click the book icons to open and browse the individual categories.

View Window

The view window always displays the currently selected contents, such as online manuals, search results, or Web pages.

Figure 50.1. The Main Window of the SUSE Help Center

The Main Window of the SUSE Help Center

[Note]Language Selects View

The documentation available in the SUSE Help Center depends on the current language. Changing your language changes the tree view.

50.1.1. Contents

The SUSE Help Center provides access to useful information from various sources. It contains special documentation for SUSE Linux Enterprise (Start-Up, KDE User Guide, GNOME User Guide, and Reference), all available information sources for your workstation environment, online help for the installed programs, and help texts for other applications. Furthermore, the SUSE Help Center provides access to SUSE's online databases that cover special hardware and software issues for SUSE Linux Enterprise. All these sources can be searched comfortably once a search index has been generated.

50.1.2. The Search Function

To search all installed information sources of SUSE Linux Enterprise, generate a search index and set a number of search parameters. To do this, use the Search tab, shown in Figure 50.2, “Configuring the Search Function”.

Figure 50.2. Configuring the Search Function

Configuring the Search Function

If no search index has been generated, the system automatically prompts you to do so when you click the Search tab or enter a search string then click Search. In the window for generating the search index, shown in Figure 50.3, “Generating a Search Index”, use the check boxes to determine the information sources to index. The index is generated when you exit the dialog with Build Index.

Figure 50.3. Generating a Search Index

Generating a Search Index

To limit the search base and the hit list as precisely as possible, use the three drop-down menus to determine the number of displayed hits and the selection area of sources to search. The following options are available for determining the selection area:

Default

A predefined selection of sources is searched.

All

All sources are searched.

None

No sources selected for the search.

Custom

Determine the sources to search by activating the respective check boxes in the overview.

When you have completed the search configuration, click Search. The relevant items are then displayed in the view window and can easily be navigated with mouse clicks.

50.2. Man Pages

Man pages are an essential part of any Linux system. They explain the usage of a command and all available options and parameters. Man pages are sorted in categories as shown in Table 50.1, “Man Pages—Categories and Descriptions” (taken from the man page for man itself).

Table 50.1. Man Pages—Categories and Descriptions

Number

Description

1

Executable programs or shell commands

2

System calls (functions provided by the kernel)

3

Library calls (functions within program libraries)

4

Special files (usually found in /dev)

5

File formats and conventions (/etc/fstab)

6

Games

7

Miscellaneous (including macro packages and conventions), for example, man(7), groff(7)

8

System administration commands (usually only for root)

9

Kernel routines (nonstandard)


Generally, man pages are delivered with the associated command. They can be browsed in the help center or directly in a shell. To display a man page in a shell, use the man command. For example, to display the man page for ls enter man ls. Each man page consists of several parts labeled NAME, SYNOPSIS, DESCRIPTION, SEE ALSO, LICENSING, and AUTHOR. There may be additional sections available depending on the type of command. With Q, exit the man page viewer.

Another possibility to display a man page is to use Konqueror. Start Konqueror and type, for example, man:/ls. If there are different categories for a command, Konqueror displays them as links.

50.3. Info Pages

Info pages are another important source of information on your system. Usually they are more verbose than man pages. You can browse an info page with an info viewer and display the different sections, called nodes. Use the command info for this task. For example, to view the info page of info itself, type info info in the shell.

For more convenience, use the Help Center or Konqueror. Start Konqueror and type info:/ to view the top level. To display the info page for grep, type info:/grep.

50.4. The Linux Documentation Project

The Linux Documentation Project (TLDP) is run by a team of volunteers who write Linux and Linux-related documentation (see http://www.tldp.org). The set of documents contains tutorials for beginners, but is mainly focused on experienced users and professional system administrators. TLDP publishes HOWTOs, FAQs, and guides (handbooks) under a free license.

50.4.1. HOWTOs

HOWTOs are usually a short, informal, step-by-step guide to accomplishing a specific task. It is written by experts for nonexperts in a procedural manner. For example, how to configure a DHCP server. HOWTOs can be found in the package howto and are installed under /usr/share/doc/howto

50.4.2. Frequently Asked Questions

FAQs (frequently asked questions) are a series of questions and answers. They originate from Usenet newsgroups where the purpose was to reduce continuous reposting of the same basic questions.

50.5. Wikipedia: The Free Online Encyclopedia

Wikipedia is a multilingual encyclopedia designed to be read and edited by anyone (see http://en.wikipedia.org). The content of Wikipedia is created by its users and is published under a free license (GFDL). Any visitors can edit articles, which gives the danger of vandalism, but this does not repel visitors. With over four hundred thousand articles, find an answer for nearly every topic.

50.6. Guides and Books

A broad range of guides and books are available for Linux topics.

50.6.1. SUSE Books

SUSE provides detailed and informative books. We provide HTML and PDF versions of our books in different languages. The PDF file is available on the DVD in the directory docu. For HTML, install the package opensuse-manual_LANG (replace LANG with your preferred language.) After the installation, find them in the SUSE Help Center.

50.6.2. Other Manuals

The SUSE help center offers additional manuals and guides for various topics or programs. More can be found at http://www.tldp.org/guides.html. They range from Bash Guide for Beginners to Linux Filesystem Hierarchy to Linux Administrator's Security Guide. Generally, guides are more detailed and exhaustive than a HOWTO or FAQ. They are usually written by experts for experts. Some of these books are old but still valid. Install books and guides with YaST.

50.7. Package Documentation

If you install a package in your system, a directory /usr/share/doc/packages/packagename is created. You can find files from the package maintainer as well as additional information from SUSE. Sometimes there are also examples, configuration files, additional scripts, or other things available. Usually you can find the following files, but they are not standard and sometimes not all files are available.

AUTHORS

The list of the main developers of this package and usually their tasks.

BUGS

Known bugs or malfunctions of this package. Usually also a link to a Bugzilla Web page where you can search all bugs.

CHANGES, ChangeLog

Summary of changes from version to version. Usually interesting for developers, because it is very detailed.

COPYING, LICENSE

Licensing information.

FAQ

Question and answers collected from mailing lists or newsgroups.

INSTALL

Procedures for installing this package in your system. Normally you do not need it, because you have the package installed already.

README, README.*

General information such as how to use it and what you can do with this package.

TODO

Things that are not implemented yet, but probably will be in the future.

MANIFEST

List of files with a brief summary.

NEWS

Description of what is new in this version.

50.8. Usenet

Created in 1979 before the rise of the Internet, Usenet is one of the oldest computer networks and still in active use. The format and transmission of Usenet articles is very similar to e-mail, but is developed for a many-to-many communication.

Usenet is organized into seven topical categories: comp.* for computer-related discussions, misc.* for miscellaneous topics, news.* for newsgroup-related matters, rec.* for recreation and entertainment, sci.* for science-related discussions, soc.* for social discussions, and talk.* for various controversial topics. The top levels are split in subgroups. For instance, comp.os.linux.hardware is a newsgroup for Linux-specific hardware issues.

Before you can post an article, have your client connect to a news server and subscribe to a specific newsgroup. News clients include Knode or Evolution. Each news server communicates to other news servers and exchanges articles with them. Not all newsgroups may be available on your news server.

Interesting newsgroups for Linux users are comp.os.linux.apps, comp.os.linux.questions, and comp.os.linux.hardware. If you cannot find a specific newsgroup, go to http://www.linux.org/docs/usenetlinux.html. Follow the general Usenet rules available online at http://www.faqs.org/faqs/usenet/posting-rules/part1/.

50.9. Standards and Specifications

There are various sources that provide information about standards or specifications.

http://www.linuxbase.org

The Free Standards Group is an independent nonprofit organization that promotes the distribution of free software and open source software. The organization endeavors to achieve this by defining distribution-independent standards. The maintenance of several standards, such as the important LSB (Linux Standard Base), is supervised by this organization.

http://www.w3.org

The World Wide Web Consortium (W3C) is certainly one of the best-known standards organizations. It was founded in October 1994 by Tim Berners-Lee and concentrates on standardizing Web technologies. W3C promotes the dissemination of open, license-free, and manufacturer-independent specifications, such as HTML, XHTML, and XML. These Web standards are developed in a four-stage process in working groups and are presented to the public as W3C recommendations (REC).

http://www.oasis-open.org

OASIS (Organization for the Advancement of Structured Information Standards) is an international consortium specializing in the development of standards for Web security, e-business, business transactions, logistics, and interoperability between various markets.

http://www.ietf.org

The Internet Engineering Task Force (IETF) is an internationally active cooperative of researchers, network designers, suppliers, and users. It concentrates on the development of Internet architecture and the smooth operation of the Internet by means of protocols.

Every IETF standard is published as an RFC (Request for Comments) and is available free-of-charge. There are six types of RFC: proposed standards, draft standards, Internet standards, experimental protocols, information documents, and historic standards. Only the first three (proposed, draft, and full) are IETF standards in the narrower sense (see http://www.ietf.org/rfc/rfc1796.txt).

http://www.ieee.org

The Institute of Electrical and Electronics Engineers (IEEE) is an organization that draws up standards in the areas of information technology, telecommunication, medicine and health care, transport, and others. IEEE standards are subject to a fee.

http://www.iso.org

The ISO Committee (International Organization for Standards) is the world's largest developer of standards and maintains a network of national standardization institutes in over 140 countries. ISO standards are subject to a fee.

http://www.din.de, http://www.din.com

The Deutsches Institut für Normung (DIN) is a registered technical and scientific association. It was founded in 1917. According to DIN, the organization is the institution responsible for standards in Germany and represents German interests in worldwide and European standards organizations.

The association brings together manufacturers, consumers, trade professionals, service companies, scientists and others who have an interest in the establishment of standards. The standards are subject to a fee and can be ordered using the DIN home page.