Blame Manuals/Texinfo/Introduction/doc-convenctions.texi

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