postgresql/doc/src/sgml/reference.sgml
Bruce Momjian a134ee3379 Update documentation on may/can/might:
Standard English uses "may", "can", and "might" in different ways:

        may - permission, "You may borrow my rake."

        can - ability, "I can lift that log."

        might - possibility, "It might rain today."

Unfortunately, in conversational English, their use is often mixed, as
in, "You may use this variable to do X", when in fact, "can" is a better
choice.  Similarly, "It may crash" is better stated, "It might crash".

Also update two error messages mentioned in the documenation to match.
2007-01-31 20:56:20 +00:00

209 lines
4.2 KiB
Text

<!-- $PostgreSQL: pgsql/doc/src/sgml/reference.sgml,v 1.62 2007/01/31 20:56:18 momjian Exp $ -->
<part id="reference">
<title>Reference</title>
<partintro>
<para>
The entries in this Reference are meant to provide in reasonable
length an authoritative, complete, and formal summary about their
respective subjects. More information about the use of
<productname>PostgreSQL</productname>, in narrative, tutorial, or
example form, can be found in other parts of this book. See the
cross-references listed on each reference page.
</para>
<para>
The reference entries are also available as traditional
<quote>man</quote> pages.
</para>
</partintro>
<reference id="sql-commands">
<title>SQL Commands</title>
<partintro>
<para>
This part contains reference information for the
<acronym>SQL</acronym> commands supported by
<productname>PostgreSQL</productname>. By <quote>SQL</quote> the
language in general is meant; information about the standards
conformance and compatibility of each command can be found on the
respective reference page.
</para>
</partintro>
&abort;
&alterAggregate;
&alterConversion;
&alterDatabase;
&alterDomain;
&alterFunction;
&alterGroup;
&alterIndex;
&alterLanguage;
&alterOperator;
&alterOperatorClass;
&alterOperatorFamily;
&alterRole;
&alterSchema;
&alterSequence;
&alterTable;
&alterTableSpace;
&alterTrigger;
&alterType;
&alterUser;
&analyze;
&begin;
&checkpoint;
&close;
&cluster;
&commentOn;
&commit;
&commitPrepared;
&copyTable;
&createAggregate;
&createCast;
&createConstraint;
&createConversion;
&createDatabase;
&createDomain;
&createFunction;
&createGroup;
&createIndex;
&createLanguage;
&createOperator;
&createOperatorClass;
&createOperatorFamily;
&createRole;
&createRule;
&createSchema;
&createSequence;
&createTable;
&createTableAs;
&createTableSpace;
&createTrigger;
&createType;
&createUser;
&createView;
&deallocate;
&declare;
&delete;
&dropAggregate;
&dropCast;
&dropConversion;
&dropDatabase;
&dropDomain;
&dropFunction;
&dropGroup;
&dropIndex;
&dropLanguage;
&dropOperator;
&dropOperatorClass;
&dropOperatorFamily;
&dropOwned;
&dropRole;
&dropRule;
&dropSchema;
&dropSequence;
&dropTable;
&dropTableSpace;
&dropTrigger;
&dropType;
&dropUser;
&dropView;
&end;
&execute;
&explain;
&fetch;
&grant;
&insert;
&listen;
&load;
&lock;
&move;
&notify;
&prepare;
&prepareTransaction;
&reassignOwned;
&reindex;
&releaseSavepoint;
&reset;
&revoke;
&rollback;
&rollbackPrepared;
&rollbackTo;
&savepoint;
&select;
&selectInto;
&set;
&setConstraints;
&setRole;
&setSessionAuth;
&setTransaction;
&show;
&startTransaction;
&truncate;
&unlisten;
&update;
&vacuum;
&values;
</reference>
<reference id="reference-client">
<title>PostgreSQL Client Applications</title>
<partintro>
<para>
This part contains reference information for
<productname>PostgreSQL</productname> client applications and
utilities. Not all of these commands are of general utility, some
might require special privileges. The common feature of these
applications is that they can be run on any host, independent of
where the database server resides.
</para>
</partintro>
&clusterdb;
&createdb;
&createlang;
&createuser;
&dropdb;
&droplang;
&dropuser;
&ecpgRef;
&pgConfig;
&pgDump;
&pgDumpall;
&pgRestore;
&psqlRef;
&reindexdb;
&vacuumdb;
</reference>
<reference id="reference-server">
<title>PostgreSQL Server Applications</title>
<partintro>
<para>
This part contains reference information for
<productname>PostgreSQL</productname> server applications and
support utilities. These commands can only be run usefully on the
host where the database server resides. Other utility programs
are listed in <xref linkend="reference-client">.
</para>
</partintro>
&initdb;
&ipcclean;
&pgControldata;
&pgCtl;
&pgResetxlog;
&postgres;
&postmaster;
</reference>
</part>