diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-04 12:17:33 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-04 12:17:33 +0000 |
commit | 5e45211a64149b3c659b90ff2de6fa982a5a93ed (patch) | |
tree | 739caf8c461053357daa9f162bef34516c7bf452 /doc/src/sgml/notation.sgml | |
parent | Initial commit. (diff) | |
download | postgresql-15-5e45211a64149b3c659b90ff2de6fa982a5a93ed.tar.xz postgresql-15-5e45211a64149b3c659b90ff2de6fa982a5a93ed.zip |
Adding upstream version 15.5.upstream/15.5
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/src/sgml/notation.sgml')
-rw-r--r-- | doc/src/sgml/notation.sgml | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/doc/src/sgml/notation.sgml b/doc/src/sgml/notation.sgml new file mode 100644 index 0000000..c3798d5 --- /dev/null +++ b/doc/src/sgml/notation.sgml @@ -0,0 +1,31 @@ +<!-- doc/src/sgml/notation.sgml --> + +<sect1 id="notation"> + <title>Conventions</title> + + <para> + The following conventions are used in the synopsis of a command: + brackets (<literal>[</literal> and <literal>]</literal>) indicate + optional parts. Braces + (<literal>{</literal> and <literal>}</literal>) and vertical lines + (<literal>|</literal>) indicate that you must choose one + alternative. Dots (<literal>...</literal>) mean that the preceding element + can be repeated. All other symbols, including parentheses, should be + taken literally. + </para> + + <para> + Where it enhances the clarity, SQL commands are preceded by the + prompt <literal>=></literal>, and shell commands are preceded by the + prompt <literal>$</literal>. Normally, prompts are not shown, though. + </para> + + <para> + 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 book does not have fixed + presumptions about system administration procedures. + </para> +</sect1> |