Commit 9c950976 authored by David Boddie's avatar David Boddie

Add information about program names

parent 90ef7424
......@@ -10,7 +10,7 @@ Style
-----
Names of executables, files and directories are typically written in a
monospaced font. This is also the case for usernames. For example:
monospaced font. This is also the case for usernames. Here are some examples:
* ``apt`` is a tool for package management.
* ``README.md`` is a file.
......@@ -24,28 +24,29 @@ the ``root`` user runs the ``apt`` tool on the development board::
root@pureos:~# apt update
In some cases, the user who is issuing a command is not given because it will
depend on your configuration. For example, when you install some packages on
your workstation you will usually issue a command like this, which includes
the shell prompt::
depend on the configuration of your system. For example, when you install some
packages on your workstation you will usually issue a command like this::
$ sudo apt install virt-manager
We may omit the shell prompt::
In this case, we include the shell prompt. However, in some situations we may
omit the shell prompt when it is obvious that we are issuing shell commands::
sudo apt install virt-manager
Where a name of a program is used instead of the executable name, we use a
normal font.
normal font. For example, we would run GNOME Builder from the command line
using the ``gnome-builder`` executable.
Distribution
------------
Distributions and Versions
--------------------------
Where we show command lines containing shell commands, the shell being used is
almost always ``bash``. Tools used on the command line are those that are
available in GNU/Linux distributions based on Debian, such as Ubuntu and
PureOS, unless we explicitly state otherwise; for example, for Fedora.
PureOS, unless we explicitly state otherwise.
In particular, any Debian packages that we mention are available in Debian
Buster. The packages available in other versions of Debian, or in other
Debian-based distributions may be usable, and we try to indicate where a
Buster. The packages available in other versions of Debian or in other
Debian-based distributions may also be usable, and we try to indicate where a
minimum version of a package is required.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment