ACC SHELL
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter 35. Help and Documentation</title><link rel="stylesheet" href="susebooks.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"><link rel="home" href="index.html" title="Documentation"><link rel="up" href="book.opensuse.reference.html" title="Reference"><link rel="prev" href="cha.filetrans.html" title="Chapter 34. Copying and Sharing Files"><link rel="next" href="app.nwscheme.html" title="Appendix A. An Example Network"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header" border="0" class="bctable"><tr><td width="80%"><div class="breadcrumbs"><p><a href="index.html"> Documentation</a><span class="breadcrumbs-sep"> > </span><a href="book.opensuse.reference.html">Reference</a><span class="breadcrumbs-sep"> > </span><strong><a accesskey="p" title="Chapter 34. Copying and Sharing Files" href="cha.filetrans.html"><span>◀</span></a> <a accesskey="n" title="Appendix A. An Example Network" href="app.nwscheme.html"><span>▶</span></a></strong></p></div></td></tr></table></div><div class="chapter" title="Chapter 35. Help and Documentation"><div class="titlepage"><div><div><h2 class="title"><a name="cha.adminhelp"></a>Chapter 35. Help and Documentation<span class="permalink"><a alt="Permalink" title="Copy Permalink" href="#cha.adminhelp">¶</a></span></h2></div></div></div><div class="toc"><p><b>Contents</b></p><dl><dt><span class="sect1"><a href="cha.adminhelp.html#sec.help.onboard.docdir">35.1. Documentation Directory</a></span></dt><dt><span class="sect1"><a href="cha.adminhelp.html#sec.help.onboard.manpages">35.2. Man Pages</a></span></dt><dt><span class="sect1"><a href="cha.adminhelp.html#sec.help.onboard.infopages">35.3. Info Pages</a></span></dt><dt><span class="sect1"><a href="cha.adminhelp.html#sec.help.wiki">35.4. openSUSE Wiki</a></span></dt></dl></div><a class="indexterm" name="id511941"></a><a class="indexterm" name="id511946"></a><div class="abstract" title="Abstract"><p class="title"><b>Abstract</b></p><p>
openSUSE® comes with various sources of information and
documentation, many of which are already integrated into your installed
system.
</p></div><div class="variablelist"><dl><dt><span class="term">Documentation in <code class="filename">/usr/share/doc</code>
</span></dt><dd><p>
This traditional help directory holds various documentation files and
release notes for your system. It contains also information of
installed packages in the subdirectory <code class="filename">packages</code>.
Find more detailed information in
<a class="xref" href="cha.adminhelp.html#sec.help.onboard.docdir" title="35.1. Documentation Directory">Section 35.1, “Documentation Directory”</a>.
</p></dd><dt><span class="term">Man Pages and Info Pages for Shell Commands</span></dt><dd><p>
When working with the shell, you do not need to know the options of the
commands by heart. Traditionally, the shell provides integrated help by
means of man pages and info pages. Read more in
<a class="xref" href="cha.adminhelp.html#sec.help.onboard.manpages" title="35.2. Man Pages">Section 35.2, “Man Pages”</a> and
<a class="xref" href="cha.adminhelp.html#sec.help.onboard.infopages" title="35.3. Info Pages">Section 35.3, “Info Pages”</a>.
</p></dd><dt><span class="term">Desktop Help Centers<a class="indexterm" name="id512029"></a>
</span></dt><dd><p>
The help centers of both the KDE desktop (KDE help center) and the GNOME desktop
(Help) provide central access to the most important documentation
resources on your system in searchable form. These resources include
online help for installed applications, man pages, info pages, and the
Novell/SUSE manuals delivered with your product.
</p></dd><dt><span class="term">Separate Help Packages for Some Applications</span></dt><dd><p>
When installing new software with YaST, the software documentation is
installed automatically (in most cases) and usually appears in the help
center of your desktop. However, some applications, such as GIMP, may
have different online help packages that can be installed separately
with YaST and do not integrate into the help centers.
</p></dd></dl></div><div class="sect1" title="35.1. Documentation Directory"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sec.help.onboard.docdir"></a>35.1. Documentation Directory<span class="permalink"><a alt="Permalink" title="Copy Permalink" href="#sec.help.onboard.docdir">¶</a></span></h2></div></div></div><p>
<a class="indexterm" name="id512084"></a> The traditional directory to find documentation on your
installed Linux system is <code class="filename">/usr/share/doc</code>. Usually,
the directory contains information about the packages installed on your
system, plus release notes, manuals, and more.
</p><div class="note"><table border="0" cellpadding="3" cellspacing="0" width="100%" summary="Note: Contents Depends on Installed Packages"><tr class="head"><td width="32"><img alt="[Note]" src="admon/note.png"></td><th align="left">Contents Depends on Installed Packages</th></tr><tr><td colspan="2" align="left" valign="top"><p>
In the Linux world, many manuals and other kinds of documentation are
available in the form of packages, just like software. How much and
which information you find in <code class="filename">/usr/share/docs</code> also
depends on the (documentation) packages installed. If you cannot find
the subdirectories mentioned here, check if the respective packages are
installed on your system and add them with YaST, if needed.
</p></td></tr></table></div><div class="sect2" title="35.1.1. Novell/SUSE Manuals"><div class="titlepage"><div><div><h3 class="title"><a name="sec.help.onboard.docdir.manual"></a>35.1.1. Novell/SUSE Manuals<span class="permalink"><a alt="Permalink" title="Copy Permalink" href="#sec.help.onboard.docdir.manual">¶</a></span></h3></div></div></div><p>
<a class="indexterm" name="id512132"></a> <a class="indexterm" name="id512144"></a> We provide HTML and PDF versions of our books in different
languages. In the <code class="filename">manual</code> subdirectory, find HTML
versions of most of the Novell/SUSE manuals available for your
product. For an overview of all documentation available for your product
refer to the preface of the manuals.
</p><p>
If more than one language is installed,
<code class="filename">/usr/share/doc/manual</code> may contain different
language versions of the manuals. The HTML versions of the Novell/SUSE
manuals are also available in the help center of both desktops. For
information on where to find the PDF and HTML versions of the books on
your installation media, refer to the openSUSE Release Notes. They
are available on your installed system under
<code class="filename">/usr/share/doc/release-notes/</code> or online at your
product-specific Web page at
<a class="ulink" href="http://www.novell.com/documentation/" target="_top">http://www.novell.com/documentation/</a>.
</p></div><div class="sect2" title="35.1.2. HOWTOs"><div class="titlepage"><div><div><h3 class="title"><a name="sec.help.onboard.docdir.howto"></a>35.1.2. HOWTOs<span class="permalink"><a alt="Permalink" title="Copy Permalink" href="#sec.help.onboard.docdir.howto">¶</a></span></h3></div></div></div><p>
<a class="indexterm" name="id512194"></a> If the <code class="systemitem">howto</code>
package is installed on your system, <code class="filename">/usr/share/doc</code>
also holds the <code class="filename">howto</code> subdirectory, where you find
additional documentation for many tasks relating to the setup and
operation of Linux software.
</p></div><div class="sect2" title="35.1.3. Package Documentation"><div class="titlepage"><div><div><h3 class="title"><a name="sec.help.onboard.docdir.pkg"></a>35.1.3. Package Documentation<span class="permalink"><a alt="Permalink" title="Copy Permalink" href="#sec.help.onboard.docdir.pkg">¶</a></span></h3></div></div></div><p>
<a class="indexterm" name="id512235"></a> Under <code class="filename">packages</code>, find the documentation
that is included in the software packages installed on your system. For
every package, a subdirectory
<code class="filename">/usr/share/doc/packages/<em class="replaceable"><code>packagename</code></em></code>
is created. It often contains README files for the package and sometimes
examples, configuration files, or additional scripts. The following list
introduces typical files to be found under
<code class="filename">/usr/share/doc/packages</code>. None of these entries are
mandatory and many packages might just include a few of them.
</p><div class="variablelist"><dl><dt><span class="term"><code class="filename">AUTHORS</code>
</span></dt><dd><p>
List of the main developers.
</p></dd><dt><span class="term"><code class="filename">BUGS</code>
</span></dt><dd><p>
Known bugs or malfunctions. Might also contain a link to a Bugzilla
Web page where you can search all bugs.
</p></dd><dt><span class="term"><code class="filename">CHANGES</code>
, </span><span class="term"><code class="filename">ChangeLog</code>
</span></dt><dd><p>
Summary of changes from version to version. Usually interesting for
developers, because it is very detailed.
</p></dd><dt><span class="term"><code class="filename">COPYING</code>
, </span><span class="term"><code class="filename">LICENSE</code>
</span></dt><dd><p>
Licensing information.
</p></dd><dt><span class="term"><code class="filename">FAQ</code>
</span></dt><dd><p>
Question and answers collected from mailing lists or newsgroups.
</p></dd><dt><span class="term"><code class="filename">INSTALL</code>
</span></dt><dd><p>
How to install this package on your system. As the package is already
installed by the time you get to read this file, you can safely
ignore the contents of this file.
</p></dd><dt><span class="term"><code class="filename">README</code>, <code class="filename">README.*</code>
</span></dt><dd><p>
General information on the software. For example, for what purpose
and how to use it.
</p></dd><dt><span class="term"><code class="filename">TODO</code>
</span></dt><dd><p>
Things that are not implemented yet, but probably will be in the
future.
</p></dd><dt><span class="term"><code class="filename">MANIFEST</code>
</span></dt><dd><p>
List of files with a brief summary.
</p></dd><dt><span class="term"><code class="filename">NEWS</code>
</span></dt><dd><p>
Description of what is new in this version.
</p></dd></dl></div></div></div><div class="sect1" title="35.2. Man Pages"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sec.help.onboard.manpages"></a>35.2. Man Pages<span class="permalink"><a alt="Permalink" title="Copy Permalink" href="#sec.help.onboard.manpages">¶</a></span></h2></div></div></div><a class="indexterm" name="id512476"></a><p>
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
can be accessed with <span class="command"><strong>man</strong></span> followed by the name of the
command, for example, <span class="command"><strong>man ls</strong></span>.
</p><p>
Man pages are displayed directly in the shell. To navigate them, move up
and down with <span class="keycap">Page ↑</span> and
<span class="keycap">Page ↓</span>. Move between the beginning and the end of
a document with <span class="keycap">Home</span> and <span class="keycap">End</span>.
End this viewing mode by pressing <span class="keycap">Q</span>. Learn more about
the <span class="command"><strong>man</strong></span> command itself with <span class="command"><strong>man
man</strong></span>. Man pages are sorted in categories as shown in
<a class="xref" href="cha.adminhelp.html#tab.help.mancategory" title="Table 35.1. Man Pages—Categories and Descriptions">Table 35.1, “Man Pages—Categories and Descriptions”</a> (taken from the man page for man
itself).
</p><div class="table"><a name="tab.help.mancategory"></a><p class="title"><b>Table 35.1. Man Pages—Categories and Descriptions</b><span class="permalink"><a alt="Permalink" title="Copy Permalink" href="#tab.help.mancategory">¶</a></span></p><div class="table-contents"><table summary="Man Pages—Categories and Descriptions" border="1"><colgroup><col><col></colgroup><thead><tr><th>
<p>
Number
</p>
</th><th>
<p>
Description
</p>
</th></tr></thead><tbody><tr><td>
<p>
1
</p>
</td><td>
<p>
Executable programs or shell commands
</p>
</td></tr><tr><td>
<p>
2
</p>
</td><td>
<p>
System calls (functions provided by the Kernel)
</p>
</td></tr><tr><td>
<p>
3
</p>
</td><td>
<p>
Library calls (functions within program libraries)
</p>
</td></tr><tr><td>
<p>
4
</p>
</td><td>
<p>
Special files (usually found in <code class="filename">/dev</code>)
</p>
</td></tr><tr><td>
<p>
5
</p>
</td><td>
<p>
File formats and conventions (<code class="filename">/etc/fstab</code>)
</p>
</td></tr><tr><td>
<p>
6
</p>
</td><td>
<p>
Games
</p>
</td></tr><tr><td>
<p>
7
</p>
</td><td>
<p>
Miscellaneous (including macro packages and conventions), for
example, man(7), groff(7)
</p>
</td></tr><tr><td>
<p>
8
</p>
</td><td>
<p>
System administration commands (usually only for <code class="systemitem">root</code>)
</p>
</td></tr><tr><td>
<p>
9
</p>
</td><td>
<p>
Kernel routines (nonstandard)
</p>
</td></tr></tbody></table></div></div><br class="table-break"><p>
Each man page consists of several parts labeled
<em class="citetitle">NAME</em>, <em class="citetitle">SYNOPSIS</em>,
<em class="citetitle">DESCRIPTION</em>, <em class="citetitle">SEE ALSO</em>,
<em class="citetitle">LICENSING</em>, and <em class="citetitle">AUTHOR</em>.
There may be additional sections available depending on the type of
command.
</p></div><div class="sect1" title="35.3. Info Pages"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sec.help.onboard.infopages"></a>35.3. Info Pages<span class="permalink"><a alt="Permalink" title="Copy Permalink" href="#sec.help.onboard.infopages">¶</a></span></h2></div></div></div><a class="indexterm" name="id512809"></a><p>
Info pages are another important source of information on your system.
Usually, they are more detailed than man pages. To view the info page for
a certain command, enter <span class="command"><strong>info</strong></span> followed by the name of
the command, for example, <span class="command"><strong>info ls</strong></span>. You can browse an
info page with a viewer directly in the shell and display the different
sections, called <span class="quote">“<span class="quote">nodes</span>”</span>. Use <span class="keycap">Space</span> to
move forward and <span class="keycap"><—</span> to move backwards. Within
a node, you can also browse with <span class="keycap">Page ↑</span> and
<span class="keycap">Page ↓</span> but only <span class="keycap">Space</span> and
<span class="keycap"><—</span> will take you also to the previous or
subsequent node. Press <span class="keycap">Q</span> to end the viewing mode. Not
every man page comes with an info page and vice versa.
</p></div><div class="sect1" title="35.4. openSUSE Wiki"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sec.help.wiki"></a>35.4. openSUSE Wiki<span class="permalink"><a alt="Permalink" title="Copy Permalink" href="#sec.help.wiki">¶</a></span></h2></div></div></div><p>
Detailed information about lots of different aspects of the openSUSE
system can be found in our Wiki at <a class="ulink" href="http://en.opensuse.org" target="_top">http://en.opensuse.org</a>.
You can contribute to each Wiki page and change or add new pages. To do
so, first register (if you have not already) and log in. Click on the
<span class="guimenu">Edit</span> link to insert your changes.
</p></div></div><div class="navfooter"><table width="100%" summary="Navigation footer" border="0" class="bctable"><tr><td width="80%"><div class="breadcrumbs"><p><a href="index.html"> Documentation</a><span class="breadcrumbs-sep"> > </span><a href="book.opensuse.reference.html">Reference</a><span class="breadcrumbs-sep"> > </span><strong><a accesskey="p" title="Chapter 34. Copying and Sharing Files" href="cha.filetrans.html"><span>◀</span></a> <a accesskey="n" title="Appendix A. An Example Network" href="app.nwscheme.html"><span>▶</span></a></strong></p></div></td></tr></table></div></body></html>
ACC SHELL 2018