From f5ed2ee53319a72ff773eccb014cf81be5847b35 Mon Sep 17 00:00:00 2001 From: Bruce Momjian Date: Tue, 6 Jan 2009 23:01:57 +0000 Subject: Add documentation for new \d*S* patch, and clean up some of the docs. Fix \do and trigger display for the patch too. --- doc/src/sgml/ref/psql-ref.sgml | 75 +++++++++++++++++++++++------------------- 1 file changed, 41 insertions(+), 34 deletions(-) (limited to 'doc/src') diff --git a/doc/src/sgml/ref/psql-ref.sgml b/doc/src/sgml/ref/psql-ref.sgml index fb394b16eef..b5a5add2aed 100644 --- a/doc/src/sgml/ref/psql-ref.sgml +++ b/doc/src/sgml/ref/psql-ref.sgml @@ -1,5 +1,5 @@ @@ -815,8 +815,7 @@ testdb=> - \d [ pattern ] - \d+ [ pattern ] + \d[S+] [ pattern ] @@ -834,6 +833,8 @@ testdb=> more information is displayed: any comments associated with the columns of the table are shown, as is the presence of OIDs in the table. + The letter S restricts the listing to system objects; without + S, only non-system objects are shown. @@ -849,7 +850,7 @@ testdb=> - \da [ pattern ] + \da[S] [ pattern ] @@ -857,14 +858,16 @@ testdb=> return type and the data types they operate on. If pattern is specified, only aggregates whose names match the pattern are shown. + The letter S restricts the listing + to system objects; without S, only + non-system objects are shown. - \db [ pattern ] - \db+ [ pattern ] + \db[+] [ pattern ] @@ -879,13 +882,15 @@ testdb=> - \dc [ pattern ] + \dc[S] [ pattern ] Lists all available conversions between character-set encodings. If pattern is specified, only conversions whose names match the pattern are listed. + The letter S restricts the listing to system objects; without + S, only non-system objects are shown. @@ -905,13 +910,15 @@ testdb=> - \dd [ pattern ] + \dd[S] [ pattern ] Shows the descriptions of objects matching the pattern, or of all visible objects if no argument is given. But in either case, only objects that have a description are listed. + The letter S restricts the listing to system objects; without + S, only non-system objects are shown. (Object covers aggregates, functions, operators, types, relations (tables, views, indexes, sequences, large objects), rules, and triggers.) For example: @@ -935,20 +942,21 @@ testdb=> - \dD [ pattern ] + \dD[S] [ pattern ] Lists all available domains. If pattern is specified, only matching domains are shown. + The letter S restricts the listing to system objects; without + S, only non-system objects are shown. - \des [ pattern ] - \des+ [ pattern ] + \des[+] [ pattern ] Lists all foreign servers (mnemonic: external @@ -964,8 +972,7 @@ testdb=> - \deu [ pattern ] - \deu+ [ pattern ] + \deu[+] [ pattern ] Lists all user mappings (mnemonic: external @@ -988,8 +995,7 @@ testdb=> - \dew [ pattern ] - \dew+ [ pattern ] + \dew[+] [ pattern ] Lists all foreign-data wrappers (mnemonic: external @@ -1005,8 +1011,7 @@ testdb=> - \df [ pattern ] - \df+ [ pattern ] + \df[S+] [ pattern ] @@ -1016,6 +1021,8 @@ testdb=> is specified, only functions whose names match the pattern are shown. If the form \df+ is used, additional information about each function, including volatility, language, source code and description, is shown. + The letter S restricts the listing to system objects; without + S, only non-system objects are shown. @@ -1037,8 +1044,7 @@ testdb=> - \dF [ pattern ] - \dF+ [ pattern ] + \dF[+] [ pattern ] Lists available text search configurations. @@ -1052,8 +1058,7 @@ testdb=> - \dFd [ pattern ] - \dFd+ [ pattern ] + \dFd[+] [ pattern ] Lists available text search dictionaries. @@ -1067,8 +1072,7 @@ testdb=> - \dFp [ pattern ] - \dFp+ [ pattern ] + \dFp[+] [ pattern ] Lists available text search parsers. @@ -1082,8 +1086,7 @@ testdb=> - \dFt [ pattern ] - \dFt+ [ pattern ] + \dFt[+] [ pattern ] Lists available text search templates. @@ -1110,7 +1113,7 @@ testdb=> - \distvS [ pattern ] + \distv[S+] [ pattern ] @@ -1120,11 +1123,12 @@ testdb=> S stand for index, sequence, table, view, and system table, respectively. You can specify any or all of these letters, in any order, to obtain a listing of all the - matching objects. The letter S restricts - the listing to system objects; without S, - only non-system objects are shown. If + is + matching objects. If + is appended to the command name, each object is listed with its physical size on disk and its associated description, if any. + The letter S restricts the listing + to system objects; without S, only + non-system objects are shown. @@ -1147,8 +1151,7 @@ testdb=> - \dn [ pattern ] - \dn+ [ pattern ] + \dn[+] [ pattern ] @@ -1164,12 +1167,15 @@ testdb=> - \do [ pattern ] + \do[S] [ pattern ] Lists available operators with their operand and return types. If pattern is specified, only operators whose names match the pattern are listed. + The letter S restricts the listing + to system objects; without S, only + non-system objects are shown. @@ -1195,14 +1201,15 @@ testdb=> - \dT [ pattern ] - \dT+ [ pattern ] + \dT[S+] [ pattern ] Lists all data types or only those that match pattern. The command form \dT+ shows extra information, namely the type's internal name, size, and allowed values for enum types. + The letter S restricts the listing to system objects; without + S, only non-system objects are shown. -- cgit v1.2.3