(mysql.info.gz) Manual conventions

 
 1.1.1 Conventions Used in This Manual
 -------------------------------------
 
 This manual uses certain typographical conventions:
 
 `constant'
      Constant-width font is used for command names and options; SQL
      statements; database, table, and column names; C and Perl code;
      and environment variables.  Example: "To see how `mysqladmin'
      works, invoke it with the `--help' option."
 
 CONSTANT ITALIC
      Italic constant-width font is used to indicate variable input for
      which you should substitute a value of your own choosing.
 
 `filename'
      Constant-width font with surrounding quotes is used for filenames
      and pathnames.  Example: "The distribution is installed under the
      `/usr/local/' directory."
 
 `c'
      Constant-width font with surrounding quotes is also used to
      indicate character sequences.  Example: "To specify a wildcard,
      use the `%' character."
 
 _italic_
      Italic font is used for emphasis, _like this_.
 
 *boldface*
      Boldface font is used in table headings and to convey *especially
      strong emphasis*.
 
 When commands are shown that are meant to be executed from within a
 particular program, the program is indicated by a prompt shown before
 the command.  For example, `shell>' indicates a command that you
 execute from your login shell, and `mysql>' indicates a statement that
 you execute from the `mysql' client program:
 
      shell> type a shell command here
      mysql> type a mysql statement here
 
 The "shell" is your command interpreter. On Unix, this is typically a
 program such as `sh' or `csh'. On Windows, the equivalent program is
 `command.com' or `cmd.exe', typically run in a console window.
 
 When you enter a command or statement shown in an example, do not type
 the prompt shown in the example.
 
 Database, table, and column names must often be substituted into
 statements.  To indicate that such substitution is necessary, this
 manual uses DB_NAME, TBL_NAME, and COL_NAME.  For example, you might
 see a statement like this:
 
      mysql> SELECT COL_NAME FROM DB_NAME.TBL_NAME;
 
 This means that if you were to enter a similar statement, you would
 supply your own database, table, and column names, perhaps like this:
 
      mysql> SELECT author_name FROM biblio_db.author_list;
 
 SQL keywords are not case sensitive and may be written in uppercase or
 lowercase.  This manual uses uppercase.
 
 In syntax descriptions, square brackets (`[' and `]') are used to
 indicate optional words or clauses.  For example, in the following
 statement, `IF EXISTS' is optional:
 
      DROP TABLE [IF EXISTS] TBL_NAME
 
 When a syntax element consists of a number of alternatives, the
 alternatives are separated by vertical bars (`|').  When one member
 from a set of choices _may_ be chosen, the alternatives are listed
 within square brackets (`[' and `]'):
 
      TRIM([[BOTH | LEADING | TRAILING] [REMSTR] FROM] STR)
 
 When one member from a set of choices _must_ be chosen, the
 alternatives are listed within braces (`{' and `}'):
 
      {DESCRIBE | DESC} TBL_NAME [COL_NAME | WILD]
 
 An ellipsis (`...') indicates the omission of a section of a statement,
 typically to provide a shorter version of more complex syntax. For
 example, `INSERT ... SELECT' is shorthand for the form of `INSERT'
 statement that is followed by a `SELECT' statement.
 
 An ellipsis can also indicate that the preceding syntax element of a
 statement may be repeated. In the following example, multiple
 RESET_OPTION values may be given, with each of those after the first
 preceded by commas:
 
      RESET RESET_OPTION [,RESET_OPTION] ...
 
 Commands for setting shell variables are shown using Bourne shell
 syntax.  For example, the sequence to set an environment variable and
 run a command looks like this in Bourne shell syntax:
 
      shell> VARNAME=VALUE SOME_COMMAND
 
 If you are using `csh' or `tcsh', you must issue commands somewhat
 differently.  You would execute the sequence just shown like this:
 
      shell> setenv VARNAME VALUE
      shell> SOME_COMMAND
Info Catalog
(mysql.info.gz) Manual-info
automatically generated byinfo2html