Our documentation is available online at https://doc.opensuse.org. Browse or download the documentation in various formats.
The latest updates are usually available in the English-language version of this documentation.
If you run into an issue, check out the Technical Information Documents (TIDs) that are available online at https://www.suse.com/support/kb/. Search the SUSE Knowledgebase for known solutions driven by customer need.
For offline use, the release notes are also available under
/usr/share/doc/release-notes
on your system.
The documentation for individual packages is available at
/usr/share/doc/packages
.
Many commands are also described in their manual
pages. To view them, run man
, followed
by a specific command name. If the man
command is
not installed on your system, install it with sudo zypper
install man
.
Your feedback and contributions to this documentation are welcome. The following channels for giving feedback are available:
Report issues with the documentation at https://bugzilla.opensuse.org/.
To simplify this process, click the
icon next to a headline in the HTML version of this document. This preselects the right product and category in Bugzilla and adds a link to the current section. You can start typing your bug report right away.A Bugzilla account is required.
To contribute to this documentation, click the
icon next to a headline in the HTML version of this document. This will take you to the source code on GitHub, where you can open a pull request.A GitHub account is required.
The
icons are only available for the English version of each document. For all other languages, use the icons instead.For more information about the documentation environment used for this documentation, see the repository's README.
You can also report errors and send feedback concerning the documentation to <doc-team@suse.com>. Include the document title, the product version, and the publication date of the document. Additionally, include the relevant section number and title (or provide the URL) and provide a concise description of the problem.
If you need further help on openSUSE Leap, see https://en.opensuse.org/Portal:Support.
The following notices and typographic conventions are used in this document:
/etc/passwd
: Directory names and file names
PLACEHOLDER: Replace PLACEHOLDER with the actual value
PATH
: An environment variable
ls
, --help
: Commands, options, and
parameters
user
: The name of a user or group
package_name: The name of a software package
Alt, Alt–F1: A key to press or a key combination. Keys are shown in uppercase as on a keyboard.
, › : menu items, buttons
Chapter 1, “Example chapter”: A cross-reference to another chapter in this guide.
Commands that must be run with root
privileges. You can also
prefix these commands with the sudo
command to run them
as a non-privileged user:
#
command
>
sudo
command
Commands that can be run by non-privileged users:
>
command
Commands can be split into two or multiple lines by a backslash character
(\
) at the end of a line. The backslash informs the shell that
the command invocation will continue after the end of the line:
>
echo
a b \ c d
A code block that shows both the command (preceded by a prompt) and the respective output returned by the shell:
>
command
output
Notices
Vital information you must be aware of before proceeding. Warns you about security issues, potential loss of data, damage to hardware, or physical hazards.
Important information you should be aware of before proceeding.
Additional information, for example about differences in software versions.
Helpful information, like a guideline or a piece of practical advice.
Compact Notices
Additional information, for example about differences in software versions.
Helpful information, like a guideline or a piece of practical advice.