Skip to content

Commit

Permalink
Updated list of available documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@tbazant
tbazant committed Jul 26, 2023
1 parent 240a101 commit 393792f
Showing 1 changed file with 30 additions and 50 deletions.
80 changes: 30 additions & 50 deletions xml/help_admin.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,17 @@
</dm:docmanager>
</info>
<para>
&productnamereg; comes with various sources of information and documentation,
&productnamereg; comes with several sources of information and documentation,
many of which are already integrated into your installed system.
</para>
<variablelist>
<varlistentry>
<term>Documentation in <filename>/usr/share/doc</filename></term>
<listitem>
<para>
This traditional help directory holds documentation files and
release notes for your system. It contains also information of installed
packages in the subdirectory <filename>packages</filename>. Find more
detailed information in <xref linkend="sec-help-onboard-docdir"/>.
This traditional help directory holds documentation of installed packages
in the subdirectory <filename>packages</filename>. Find more detailed
information in <xref linkend="sec-help-onboard-docdir"/>.
</para>
</listitem>
</varlistentry>
Expand Down Expand Up @@ -57,7 +56,7 @@
<listitem>
<para>
When installing new software with &yast;, the software documentation is
usually installed automatically and appears in the help center of your
normally installed automatically and appears in the help center of your
desktop. However, certain 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.
Expand All @@ -69,51 +68,23 @@
<title>Documentation directory</title>

<para>
The traditional directory to find documentation on your
installed Linux system is <filename>/usr/share/doc</filename>. The
directory contains information about the packages installed on your system,
plus release notes, manuals and more.
The traditional directory to find documentation on your installed Linux
system is <filename>/usr/share/doc</filename> and contains information about
the packages installed on your system.
</para>

<note>
<title>Contents depends on installed packages</title>
<para>
In the Linux world, many manuals and other kinds of documentation are
available in the form of packages, like software. How much and which
information you find in <filename>/usr/share/docs</filename> also depends
information you find in <filename>/usr/share/doc</filename> 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.
</para>
</note>

<sect2 xml:id="sec-help-onboard-docdir-manual">
<title>&suse; manuals</title>
<para>
We provide HTML and PDF versions of our books in different
languages. In the <filename>manual</filename> subdirectory, find HTML
versions of most of the &suse; manuals available for your product. For an
overview of all documentation available for your product refer to the
preface of the manuals.
</para>
<para>
If more than one language is installed,
<filename>/usr/share/doc/manual</filename> may contain different language
versions of the manuals. The HTML versions of the &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 &productname; Release Notes. They are available on your
installed system under <filename>/usr/share/doc/release-notes/</filename>
or online at your product-specific Web page at <link os="sles;sled"
xlink:href="https://www.suse.com/releasenotes//"/><link os="osuse"
xlink:href="https://doc.opensuse.org/release-notes/"/>.
</para>
<!--The PDF files are available on the DVD in the directory
<filename>docu</filename>. For HTML, install the packages
<systemitem>opensuse-manual_LANG</systemitem> (replace
<replaceable>LANG</replaceable> with your preferred language.)-->
</sect2>

<sect2 xml:id="sec-help-onboard-docdir-pkg">
<title>Package documentation</title>
<para>
Expand Down Expand Up @@ -314,7 +285,7 @@
</entry>
<entry>
<para>
Special files (usually found in <filename>/dev</filename>)
Special files (normally found in <filename>/dev</filename>)
</para>
</entry>
</row>
Expand Down Expand Up @@ -363,7 +334,7 @@
</entry>
<entry>
<para>
System administration commands (usually only for &rootuser;)
System administration commands (normally only for &rootuser;)
</para>
</entry>
</row>
Expand Down Expand Up @@ -396,17 +367,17 @@

<para>
Info pages are another important source of information on your system.
Usually, they are more detailed than man pages. They consist of more than
command line options and contain sometimes whole tutorials or reference
They are more detailed than man pages. They consist of more than
command-line options and contain sometimes whole tutorials or reference
documentation. To view the info page for a certain command, enter
<command>info</command> followed by the name of the command, for example,
<command>info ls</command>. You can browse an info page with a viewer
directly in the shell and display the different sections, called
<quote>nodes</quote>. Use <keycap function="space"/> to move forward and
<keycap function="backspace"/> to move backward. Within a node, you can also
browse with <keycap function="pageup"/> and <keycap function="pagedown"/>
but only <keycap function="space"/> and <keycap function="backspace"/> will
take you also to the previous or subsequent node. Press <keycap>Q</keycap>
but only <keycap function="space"/> and <keycap function="backspace"/>
takes you also to the previous or subsequent node. Press <keycap>Q</keycap>
to end the viewing mode. Not every command comes with an info page and vice
versa.
</para>
Expand All @@ -429,6 +400,15 @@
</para>

<variablelist>
<varlistentry os="sles;sled">
<term>Release notes</term>
<listitem>
<para>
For release notes, see <link
xlink:href="https://www.suse.com/releasenotes/"/>.
</para>
</listitem>
</varlistentry>
<varlistentry os="sles;sled">
<term>&suse; technical support</term>
<listitem>
Expand Down Expand Up @@ -473,12 +453,12 @@
<para>
The Linux Documentation Project (TLDP) is run by a team of volunteers who
write Linux-related documentation (see
<link xlink:href="https://www.tldp.org"/>). It is probably the most
comprehensive documentation resource for Linux. 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. Parts of the
documentation from TLDP are also available on &productname;.
<link xlink:href="https://www.tldp.org"/>). It is a comprehensive
documentation resource for Linux. 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. Parts of the documentation from TLDP are also
available on &productname;.
</para>
</listitem>
</varlistentry>
Expand Down

0 comments on commit 393792f

Please sign in to comment.