Blame Manuals/RepoReference/en_US/Introduction/doc-convenctions.texinfo

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