notation.sgml 2.5 KB
Newer Older
1
<!--
2
$Header: /cvsroot/pgsql/doc/src/sgml/notation.sgml,v 1.16 2001/09/13 15:55:23 petere Exp $
3 4
-->

5 6
<sect1 id="notation">
 <title>Terminology and Notation</title>
7

Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
8
 <para>
9 10 11
  The terms <quote>Postgres</quote> and <quote>PostgreSQL</quote> will be
  used interchangeably to refer to the software that accompanies this
  documentation.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
12
 </para>
13

Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
14
 <para>
15 16 17 18 19 20
  An <firstterm>administrator</firstterm> is generally a person who is
  in charge of installing and running the server.  A <firstterm>user</firstterm>
  could be anyone who is using, or wants to use, any part of the
  <productname>PostgreSQL</productname> system.  These terms should not
  be interpreted too narrowly; this documentation set does not have fixed
  presumptions about system administration procedures.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
21
 </para>
22

Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
23
 <para>
24 25 26 27
  <filename>/usr/local/pgsql/</filename> is generally used as the root
  directory of the installation and <filename>/usr/local/pgsql/data</filename>
  as the directory with the database files.  These directories may vary
  on your site, details can be derived in the <citetitle>Administrator's Guide</citetitle>.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
28
 </para>
29

Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
30 31
 <para>
  In a command synopsis, brackets
32
  (<literal>[</literal> and <literal>]</literal>) indicate an optional phrase or keyword.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
33
  Anything in braces
34 35
  (<literal>{</literal> and <literal>}</literal>) and containing vertical bars
  (<literal>|</literal>)
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
36 37
  indicates that you must choose one.
 </para>
38

Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
39 40
 <para>
  Examples will show commands executed from various accounts and programs.
41
  Commands executed from a Unix shell may be preceded with a dollar sign
42
  (<quote><literal>$</literal></quote>).  Commands executed from particular user
43 44
  accounts such as <systemitem>root</> or <systemitem>postgres</> are specially flagged and explained.
  <acronym>SQL</acronym> commands may be preceded with
45
  <quote><literal>=&gt;</literal></quote>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
46 47
  or will have no leading prompt, depending on the context.
 </para>
48

Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
49 50
 <note>
  <para>
51
   The notation for
52
   flagging commands is not universally consistent throughout the
53
   documentation set.
54 55
   Please report problems to the documentation mailing list
   <email>pgsql-docs@postgresql.org</email>.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
56 57
  </para>
 </note>
58 59

</sect1>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
60 61 62

<!-- Keep this comment at the end of the file
Local variables:
63
mode:sgml
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
64 65 66 67 68 69 70 71 72
sgml-omittag:nil
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"./reference.ced"
sgml-exposed-tags:nil
73
sgml-local-catalogs:("/usr/lib/sgml/catalog")
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
74 75 76
sgml-local-ecat-files:nil
End:
-->