1<!-- doc/src/sgml/notation.sgml -->
2
3<sect1 id="notation">
4 <title>Conventions</title>
5
6 <para>
7  The following conventions are used in the synopsis of a command:
8  brackets (<literal>[</literal> and <literal>]</literal>) indicate
9  optional parts.  (In the synopsis of a Tcl command, question marks
10  (<literal>?</literal>) are used instead, as is usual in Tcl.)  Braces
11  (<literal>{</literal> and <literal>}</literal>) and vertical lines
12  (<literal>|</literal>) indicate that you must choose one
13  alternative.  Dots (<literal>...</literal>) mean that the preceding element
14  can be repeated.
15 </para>
16
17 <para>
18  Where it enhances the clarity, SQL commands are preceded by the
19  prompt <literal>=&gt;</literal>, and shell commands are preceded by the
20  prompt <literal>$</literal>.  Normally, prompts are not shown, though.
21 </para>
22
23 <para>
24  An <firstterm>administrator</firstterm> is generally a person who is
25  in charge of installing and running the server.  A <firstterm>user</firstterm>
26  could be anyone who is using, or wants to use, any part of the
27  <productname>PostgreSQL</productname> system.  These terms should not
28  be interpreted too narrowly; this book does not have fixed
29  presumptions about system administration procedures.
30 </para>
31</sect1>
32