|
|
e935c3 |
|
|
|
e935c3 |
<section>
|
|
|
e935c3 |
|
|
|
e935c3 |
<title>Document convenctions</title>
|
|
|
e935c3 |
|
|
|
e935c3 |
<para>In this manual the personal pronoun @emph{we} is used to
|
|
|
e935c3 |
repesent @emph{The CentOS Artwork SIG}. This is, the group of
|
|
|
e935c3 |
persons building the CentOS Artwork Repository.</para>
|
|
|
e935c3 |
|
|
|
e935c3 |
<para>In this manual, certain words are represented in different
|
|
|
e935c3 |
fonts, typefaces, sizes, and weights. This highlighting is
|
|
|
e935c3 |
systematic; different words are represented in the same style to
|
|
|
e935c3 |
indicate their inclusion in a specific category. The types of
|
|
|
e935c3 |
words that are represented this way include the following:</para>
|
|
|
e935c3 |
|
|
|
e935c3 |
<glosslist>
|
|
|
e935c3 |
<glossentry>
|
|
|
e935c3 |
<glossterm><command>command</command></glossterm>
|
|
|
e935c3 |
<glossdef>
|
|
|
e935c3 |
<para> Linux commands (and other operating system
|
|
|
e935c3 |
commands, when used) are represented this way. This
|
|
|
e935c3 |
style should indicate to you that you can type the
|
|
|
e935c3 |
word or phrase on the command line and press Enter to
|
|
|
e935c3 |
invoke a command. Sometimes a command contains words
|
|
|
e935c3 |
that would be displayed in a different style on their
|
|
|
e935c3 |
own (such as file names). In these cases, they are
|
|
|
e935c3 |
considered to be part of the command, so the entire
|
|
|
e935c3 |
phrase is displayed as a command. For example:</para>
|
|
|
e935c3 |
|
|
|
e935c3 |
<para>Use the @command{centos-art identity
|
|
|
e935c3 |
--render='path/to/dir'} command to produce contents
|
|
|
e935c3 |
inside the @file{trunk/Identity} directory structure.
|
|
|
e935c3 |
</para>
|
|
|
e935c3 |
</glossdef>
|
|
|
e935c3 |
</glossentry>
|
|
|
e935c3 |
|
|
|
e935c3 |
<glossentry>
|
|
|
e935c3 |
<glossterm><filename>file name</filename></glossterm>
|
|
|
e935c3 |
<glossdef>
|
|
|
e935c3 |
<para>File names, directory names, paths, and RPM
|
|
|
e935c3 |
package names are represented this way. This style
|
|
|
e935c3 |
indicates that a particular file or directory exists
|
|
|
e935c3 |
with that name on your system. Examples:</para>
|
|
|
e935c3 |
|
|
|
e935c3 |
<para>The @file{init.sh} file in
|
|
|
e935c3 |
@file{trunk/Scripts/Bash/Cli/} directory is the
|
|
|
e935c3 |
initialization script, written in Bash, used to
|
|
|
e935c3 |
automate most of tasks in the repository.</para>
|
|
|
e935c3 |
|
|
|
e935c3 |
<para>The @command{centos-art} command uses the
|
|
|
e935c3 |
@file{ImageMagick} RPM package to convert images from
|
|
|
e935c3 |
PNG format to other formats.</para>
|
|
|
e935c3 |
</glossdef>
|
|
|
e935c3 |
</glossentry>
|
|
|
e935c3 |
|
|
|
e935c3 |
<glossentry>
|
|
|
e935c3 |
<glossterm><keycap>key</keycap></glossterm>
|
|
|
e935c3 |
<glossdef>
|
|
|
e935c3 |
<para> A key on the keyboard is shown in this style.
|
|
|
e935c3 |
For example:</para>
|
|
|
e935c3 |
|
|
|
e935c3 |
<para>To use <keycap>TAB</keycap> completion to list
|
|
|
e935c3 |
particular files in a directory, type @command{ls},
|
|
|
e935c3 |
then a character, and finally the Tab key. Your
|
|
|
e935c3 |
terminal displays the list of files in the working
|
|
|
e935c3 |
directory that begin with that character.</para>
|
|
|
e935c3 |
</glossdef>
|
|
|
e935c3 |
</glossentry>
|
|
|
e935c3 |
|
|
|
e935c3 |
<glossentry>
|
|
|
e935c3 |
<glossterm><keycombo action="simul"><keycap>key-combination</keycap></keycombo></glossterm>
|
|
|
e935c3 |
<glossdef>
|
|
|
e935c3 |
<para>A combination of keystrokes is represented in
|
|
|
e935c3 |
this way. For example:</para>
|
|
|
e935c3 |
|
|
|
e935c3 |
<para>The
|
|
|
e935c3 |
action="simul"><keycap>Ctrl</keycap><keycap>Alt</keycap><keycap>Backspace</keycap></keycombo>
|
|
|
e935c3 |
key combination exits your graphical session and
|
|
|
e935c3 |
returns you to the graphical login screen or the
|
|
|
e935c3 |
console.</para>
|
|
|
e935c3 |
|
|
|
e935c3 |
</glossdef>
|
|
|
e935c3 |
|
|
|
e935c3 |
</glossentry>
|
|
|
e935c3 |
|
|
|
e935c3 |
<glossentry>
|
|
|
e935c3 |
<glossterm><computeroutput>computer output</computeroutput></glossterm>
|
|
|
e935c3 |
<glossdef>
|
|
|
e935c3 |
<para> Text in this style indicates text displayed to a
|
|
|
e935c3 |
shell prompt such as error messages and responses to
|
|
|
e935c3 |
commands. For example:</para>
|
|
|
e935c3 |
|
|
|
e935c3 |
<para>The @command{ls} command displays the contents of a
|
|
|
e935c3 |
directory. For example:
|
|
|
e935c3 |
|
|
|
e935c3 |
<programlisting>
|
|
|
e935c3 |
Config help_renameEntry.sh
|
|
|
e935c3 |
help_copyEntry.sh help_restoreCrossReferences.sh
|
|
|
e935c3 |
help_deleteCrossReferences.sh help_searchIndex.sh
|
|
|
e935c3 |
</programlisting>
|
|
|
e935c3 |
|
|
|
e935c3 |
The output returned in response to the command (in this
|
|
|
e935c3 |
case, the contents of the directory) is shown in this
|
|
|
e935c3 |
style.</para>
|
|
|
e935c3 |
</glossdef>
|
|
|
e935c3 |
</glossentry>
|
|
|
e935c3 |
</glosslist>
|
|
|
e935c3 |
|
|
|
e935c3 |
<para>Additionally, we use several different strategies to draw
|
|
|
e935c3 |
your attention to certain pieces of information. In order of
|
|
|
e935c3 |
urgency, these items are marked as a note, tip, important,
|
|
|
e935c3 |
caution, or warning. For example:</para>
|
|
|
e935c3 |
|
|
|
e935c3 |
<note>
|
|
|
e935c3 |
<para>@strong{Note} Remember that Linux is case sensitive. In
|
|
|
e935c3 |
other words, a rose is not a ROSE is not a rOsE.</para>
|
|
|
e935c3 |
</note>
|
|
|
e935c3 |
|
|
|
e935c3 |
<tip>
|
|
|
e935c3 |
<para>@strong{Tip} The directory @file{/usr/share/doc/}
|
|
|
e935c3 |
contains additional documentation for packages installed on
|
|
|
e935c3 |
your system.</para>
|
|
|
e935c3 |
</tip>
|
|
|
e935c3 |
|
|
|
e935c3 |
<important>
|
|
|
e935c3 |
<para>@strong{Important} If you modify the DHCP configuration
|
|
|
e935c3 |
file, the changes do not take effect until you restart the
|
|
|
e935c3 |
DHCP daemon.</para>
|
|
|
e935c3 |
</important>
|
|
|
e935c3 |
|
|
|
e935c3 |
<caution>
|
|
|
e935c3 |
<para>@strong{Caution} Do not perform routine tasks as root
|
|
|
e935c3 |
— use a regular user account unless you need to use the root
|
|
|
e935c3 |
account for system administration tasks.</para>
|
|
|
e935c3 |
</caution>
|
|
|
e935c3 |
|
|
|
e935c3 |
<warning>
|
|
|
e935c3 |
<para>@strong{Warning} Be careful to remove only the necessary
|
|
|
e935c3 |
partitions. Removing other partitions could result in data
|
|
|
e935c3 |
loss or a corrupted system environment.</para>
|
|
|
e935c3 |
</warning>
|
|
|
e935c3 |
|
|
|
e935c3 |
</section>
|