1.4 Document Convenctions

In this manual the personal pronoun we is used to repesent The CentOS Artwork SIG. This is, the group of persons building the CentOS Artwork Repository.

In this manual, certain words are represented in different fonts, typefaces, sizes, and weights. This highlighting is systematic; different words are represented in the same style to indicate their inclusion in a specific category. The types of words that are represented this way include the following:

command

Linux commands (and other operating system commands, when used) are represented this way. This style should indicate to you that you can type the word or phrase on the command line and press Enter to invoke a command. Sometimes a command contains words that would be displayed in a different style on their own (such as file names). In these cases, they are considered to be part of the command, so the entire phrase is displayed as a command. For example:

Use the centos-art identity --render='path/to/dir' command to produce contents inside the `trunk/Identity' directory structure.

`file name'

File names, directory names, paths, and RPM package names are represented this way. This style indicates that a particular file or directory exists with that name on your system. Examples:

The `init.sh' file in `trunk/Scripts/Bash/Cli/' directory is the initialization script, written in Bash, used to automate most of tasks in the repository.

The centos-art command uses the `ImageMagick' RPM package to convert images from PNG format to other formats.

key

A key on the keyboard is shown in this style. For example:

To use TAB completion to list particular files in a directory, type ls, then a character, and finally the Tab key. Your terminal displays the list of files in the working directory that begin with that character.

key-combination

A combination of keystrokes is represented in this way. For example:

The Ctrl-Alt-Backspace key combination exits your graphical session and returns you to the graphical login screen or the console.

computer output

Text in this style indicates text displayed to a shell prompt such as error messages and responses to commands. For example:

The ls command displays the contents of a directory. For example:

Config                           manual_renameEntry.sh
manual_copyEntry.sh              manual_restoreCrossReferences.sh
manual_deleteCrossReferences.sh  manual_searchIndex.sh

The output returned in response to the command (in this case, the contents of the directory) is shown in this style.

Additionally, we use several different strategies to draw your attention to certain pieces of information. In order of urgency, these items are marked as a note, tip, important, caution, or warning. For example:

Note

Remember that Linux is case sensitive. In other words, a rose is not a ROSE is not a rOsE.

Tip

The directory `/usr/share/doc/' contains additional documentation for packages installed on your system.

Important

If you modify the DHCP configuration file, the changes do not take effect until you restart the DHCP daemon.

Caution

Do not perform routine tasks as root -- use a regular user account unless you need to use the root account for system administration tasks.

Warning

Be careful to remove only the necessary partitions. Removing other partitions could result in data loss or a corrupted system environment.

This document was generated on March, 30 2011 using texi2html 1.76.