1.2 Format for describing the files

This section explains the format for describing the files and symbols used in the description.

Organization of this section
(1) Format for describing the files
(2) Symbols used in syntax

(1) Format for describing the files

Chapter 2 and proceeding chapters use the following format to describe the files:

Format
Shows the coding format of the file.
File storage location
Describes the location for storing the file.
Functionality
Explains the functionality of the file.
Specifiable keys
Explains the keys that can be specified in the file.
Specifiable parameters
Explains the parameters that can be specified in the file.
Examples of coding
Shows an example of coding of the file contents.
Precautions
Explains the points to remember when you set up or use the file.
Reference note
Not all of the above items are explained for each file. Additional file-specific information is also provided for some files.

(2) Symbols used in syntax

The following table lists and describes the symbols and syntax elements used in file description.

Table 1-6 Symbols used in the file description

SymbolConvention
|In syntax explanations, a vertical bar separates multiple items, and has the meaning of OR. For example:
A|B|C means A, or B, or C.
[ ]In syntax explanations, square brackets indicate that the enclosed item or items are optional. For example:
[A] means that you can specify A or nothing.
[B|C] means that you can specify B, or C, or nothing.
{ }In syntax explanations, curly brackets indicate that only one of the enclosed items is to be selected. For example:
{A|B|C} means only one of A, or B, or C.
...In syntax explanations, ... indicate that description is omitted.
ABC... means that there is a description after ABC, and this description is omitted.
Alternatively, in syntax explanations, an ellipsis indicates that the immediately preceding item can be repeated as many times as necessary. For example:
<Property>...means that you can specify as many properties as necessary.
< >In syntax explanations, angle brackets indicate a variable.
For example:
<Property> means that the user enters a property name or a property name is displayed.
<File name> means that the user enters a file name.
Note:
Use single-byte characters for all the symbols.