postgresql/doc/src/sgml
Tom Lane 7d8cbeb0c3 Fix examples of how to use "su" while starting the server.
The syntax "su -c 'command' username" is not accepted by all versions of
su, for example not OpenBSD's.  More portable is "su username -c
'command'".  So change runtime.sgml to recommend that syntax.  Also,
add a -D switch to the OpenBSD example script, for consistency with other
examples.  Per Denis Lapshin and Gábor Hidvégi.
2012-09-25 13:52:53 -04:00
..
ref Minor corrections for ALTER TYPE ADD VALUE IF NOT EXISTS patch. 2012-09-22 18:35:22 -04:00
.gitignore
acronyms.sgml Add SP-GiST (space-partitioned GiST) index access method. 2011-12-17 16:42:30 -05:00
adminpack.sgml
advanced.sgml Revert: In docs, change a few cases of "not important" to 2012-08-16 11:26:40 -04:00
arch-dev.sgml
array.sgml Document that && can be used to search arrays. 2012-06-22 08:59:41 -04:00
auth-delay.sgml Remove the custom_variable_classes parameter. 2011-10-04 12:36:55 -04:00
auto-explain.sgml Fix wording, per Peter Geoghegan 2012-01-27 10:36:27 +01:00
backup.sgml Doc correction to point out that 9.2+ can overwrite pg_xlog files. 2012-08-08 22:34:46 +01:00
biblio.sgml
bki.sgml
btree-gin.sgml
btree-gist.sgml
catalogs.sgml Fix catalog docs to reflect connoinherit change in 09ff76f. 2012-09-12 14:23:50 -04:00
charset.sgml In documentation, change "recommendable" to "recommended", per 2012-08-14 12:36:48 -04:00
chkpass.sgml
citext.sgml
client-auth.sgml Update URLs that pointed to sun.com; either repoint them or remove 2012-09-02 09:16:26 -04:00
config.sgml Add support for include_dir in config file. 2012-09-24 18:07:53 +03:00
contacts.sgml
contrib-spi.sgml
contrib.sgml Split contrib documentation into extensions and programs 2012-05-09 20:39:53 +03:00
cube.sgml
datatype.sgml Remove old documentation warnings about the use of bigint. 2012-08-30 13:13:46 -04:00
datetime.sgml Improve documentation around historical calendar rules. 2012-04-26 18:28:52 -04:00
dblink.sgml Improve efficiency of dblink by using libpq's new row processor API. 2012-04-04 18:39:08 -04:00
ddl.sgml Provide adequate documentation of the "table_name *" notation. 2012-09-17 14:59:31 -04:00
dfunc.sgml Remove BSD/OS (BSDi) port. There are no known users upgrading to 2012-05-03 10:58:44 -04:00
dict-int.sgml
dict-xsyn.sgml
diskusage.sgml
dml.sgml
docguide.sgml Document that xslt-related RPMs may be needed to build docs. 2012-08-30 10:39:03 -04:00
dummy-seclabel.sgml Fix typo in dummy_seclabel documentation. 2011-10-13 12:16:07 -04:00
earthdistance.sgml Fix typos in docs, some words were doubled. 2012-04-10 09:31:31 +03:00
ecpg.sgml Documentation spell and markup checking 2012-06-08 00:06:20 +03:00
errcodes.sgml
event-trigger.sgml Syntax support and documentation for event triggers. 2012-07-18 10:16:16 -04:00
extend.sgml Further review of range-types patch. 2011-11-18 18:24:32 -05:00
external-projects.sgml Remove references to pgfoundry as recommended hosting platform 2012-07-04 08:59:35 +02:00
fdwhandler.sgml Documentation spell and markup checking 2012-06-08 00:06:20 +03:00
features.sgml Update SQL features/conformance information to SQL:2011 2012-05-17 09:50:04 +03:00
file-fdw.sgml Documentation spell and markup checking 2012-06-08 00:06:20 +03:00
filelist.sgml Syntax support and documentation for event triggers. 2012-07-18 10:16:16 -04:00
fixrtf
func.sgml More documentation updates for LATERAL. 2012-09-01 00:40:25 -04:00
fuzzystrmatch.sgml
generate_history.pl Run newly-configured perltidy script on Perl files. 2012-07-04 21:47:49 -04:00
generate-errcodes-table.pl Run newly-configured perltidy script on Perl files. 2012-07-04 21:47:49 -04:00
geqo.sgml
gin.sgml Documentation spell and markup checking 2012-06-08 00:06:20 +03:00
gist.sgml Documentation spell and markup checking 2012-06-08 00:06:20 +03:00
high-availability.sgml Normalize some British spellings 2012-08-24 22:50:43 -04:00
history.sgml Add small doc mention that libpq is named after POSTQUEL. 2012-09-02 08:42:03 -04:00
hstore.sgml Remove hstore's text => text operator. 2011-11-07 21:47:45 -05:00
indexam.sgml Documentation spell and markup checking 2012-06-08 00:06:20 +03:00
indices.sgml Add SP-GiST (space-partitioned GiST) index access method. 2011-12-17 16:42:30 -05:00
info.sgml
information_schema.sgml Fix typo in information_schema documentation. 2012-09-05 23:37:42 -04:00
install-windows.sgml Support for building with MS Visual Studio 2010. 2012-01-03 08:44:26 -05:00
installation.sgml Update URLs that pointed to sun.com; either repoint them or remove 2012-09-02 09:16:26 -04:00
intagg.sgml
intarray.sgml
intro.sgml
isn.sgml
jadetex.cfg
keywords.sgml Implement SQL-standard LATERAL subqueries. 2012-08-07 19:02:54 -04:00
legal.sgml Remove confusing half sentence from legal notice 2012-06-20 00:12:05 +03:00
libpq.sgml Replace libpq's "row processor" API with a "single row" mode. 2012-08-02 13:10:30 -04:00
lo.sgml Add more limited large object trigger example. 2012-08-14 23:25:20 -04:00
lobj.sgml
ltree.sgml Revert: In docs, change a few cases of "not important" to 2012-08-16 11:26:40 -04:00
maintenance.sgml Fix documentation reference to maximum allowed for autovacuum_freeze_max_age. 2012-09-16 11:59:50 -05:00
Makefile Untabify DSSSL and XSL files and add to check-tabs target 2012-04-19 22:38:14 +03:00
manage-ag.sgml In documentation, change "recommendable" to "recommended", per 2012-08-14 12:36:48 -04:00
mk_feature_tables.pl Run newly-configured perltidy script on Perl files. 2012-07-04 21:47:49 -04:00
monitoring.sgml Documentation spell and markup checking 2012-06-08 00:06:20 +03:00
mvcc.sgml Add a note to the MVCC chapter that some things aren't transactional. 2012-08-21 11:10:17 -04:00
nls.sgml
notation.sgml
oid2name.sgml Make documentation of --help and --version options more consistent 2012-06-18 02:46:59 +03:00
pageinspect.sgml
passwordcheck.sgml In documentation, change "recommendable" to "recommended", per 2012-08-14 12:36:48 -04:00
perform.sgml Documentation spell and markup checking 2012-06-08 00:06:20 +03:00
pgarchivecleanup.sgml Make documentation of --help and --version options more consistent 2012-06-18 02:46:59 +03:00
pgbench.sgml Make pgbench vacuum before building indexes. 2012-07-23 14:42:35 -04:00
pgbuffercache.sgml
pgcrypto.sgml
pgfreespacemap.sgml
pgrowlocks.sgml Documentation spell and markup checking 2012-06-08 00:06:20 +03:00
pgstandby.sgml Make documentation of --help and --version options more consistent 2012-06-18 02:46:59 +03:00
pgstatstatements.sgml Rename I/O timing statistics columns to blk_read_time and blk_write_time. 2012-04-29 18:13:33 -04:00
pgstattuple.sgml
pgtestfsync.sgml Make documentation of --help and --version options more consistent 2012-06-18 02:46:59 +03:00
pgtesttiming.sgml Clarify FreeBSD instructions in pg_test_timing. 2012-08-30 18:38:00 -04:00
pgtrgm.sgml Document that contrib/pgtrgm only processes ASCII alphanumeric 2011-09-05 13:24:45 -04:00
pgupgrade.sgml Document that pg_upgrade requires PGHOST be set for any pre-9.1 servers 2012-09-04 09:17:30 -04:00
planstats.sgml Update and extend the EXPLAIN-related documentation. 2011-09-28 19:39:54 -04:00
plhandler.sgml Some markup cleanup to deconfuse the find_gt_lt tool 2011-08-30 20:32:49 +03:00
plperl.sgml Fix minor stylistic issue 2012-04-24 21:16:07 +03:00
plpgsql.sgml Properly document that NEW is unassigned in plpgsql for DELETE (not 2012-08-15 20:29:58 -04:00
plpython.sgml Add link to PEP 394 regarding python2 vs python3 naming 2012-07-14 13:06:09 +03:00
pltcl.sgml
postgres.sgml Syntax support and documentation for event triggers. 2012-07-18 10:16:16 -04:00
problems.sgml
protocol.sgml Revert doc patch 305557984d as the values 2012-09-01 12:05:01 -04:00
queries.sgml Provide adequate documentation of the "table_name *" notation. 2012-09-17 14:59:31 -04:00
query.sgml
rangetypes.sgml Fix typo in example. 2012-08-23 11:58:11 +03:00
README.links
recovery-config.sgml Make superuser imply replication privilege. The idea of a privilege that 2012-01-14 18:22:16 +02:00
reference.sgml Syntax support and documentation for event triggers. 2012-07-18 10:16:16 -04:00
regress.sgml
release-7.4.sgml Lots of doc corrections. 2012-04-23 22:43:09 -04:00
release-8.0.sgml Lots of doc corrections. 2012-04-23 22:43:09 -04:00
release-8.1.sgml Lots of doc corrections. 2012-04-23 22:43:09 -04:00
release-8.2.sgml Lots of doc corrections. 2012-04-23 22:43:09 -04:00
release-8.3.sgml Update release notes for 9.2.1, 9.1.6, 9.0.10, 8.4.14, 8.3.21. 2012-09-19 17:39:31 -04:00
release-8.4.sgml Update release notes for 9.2.1, 9.1.6, 9.0.10, 8.4.14, 8.3.21. 2012-09-19 17:39:31 -04:00
release-9.0.sgml Update release notes for 9.2.1, 9.1.6, 9.0.10, 8.4.14, 8.3.21. 2012-09-19 17:39:31 -04:00
release-9.1.sgml Update release notes for 9.2.1, 9.1.6, 9.0.10, 8.4.14, 8.3.21. 2012-09-19 17:39:31 -04:00
release-9.2.sgml Update release notes for 9.2.1, 9.1.6, 9.0.10, 8.4.14, 8.3.21. 2012-09-19 17:39:31 -04:00
release-old.sgml
release.sgml Remove whitespace from end of lines 2012-05-15 22:19:41 +03:00
rowtypes.sgml Further review of range-types patch. 2011-11-18 18:24:32 -05:00
rules.sgml Documentation spell and markup checking 2012-06-08 00:06:20 +03:00
runtime.sgml Fix examples of how to use "su" while starting the server. 2012-09-25 13:52:53 -04:00
seg.sgml
sepgsql.sgml Documentation spell and markup checking 2012-06-08 00:06:20 +03:00
sourcerepo.sgml
sources.sgml
spgist.sgml Documentation spell and markup checking 2012-06-08 00:06:20 +03:00
spi.sgml Redesign the plancache mechanism for more flexibility and efficiency. 2011-09-16 00:43:52 -04:00
sql.sgml doc: Fix for too many brackets in command synopses on man pages 2012-05-03 22:58:00 +03:00
sslinfo.sgml
standalone-install.sgml
start.sgml
storage.sgml Document that PGDATA has to point to the configuration files, rather 2012-08-15 22:59:37 -04:00
stylesheet-common.xsl Fix display of <command> elements on man pages 2012-04-30 21:18:03 +03:00
stylesheet-fo.xsl Fix display of <command> elements on man pages 2012-04-30 21:18:03 +03:00
stylesheet-hh.xsl Fix display of <command> elements on man pages 2012-04-30 21:18:03 +03:00
stylesheet-man.xsl Show step titles in the pg_upgrade man page 2012-07-17 21:34:22 +03:00
stylesheet.css
stylesheet.dsl Untabify DSSSL and XSL files and add to check-tabs target 2012-04-19 22:38:14 +03:00
stylesheet.xsl Fix display of <command> elements on man pages 2012-04-30 21:18:03 +03:00
syntax.sgml Add section IDs to subsections of syntax.sgml that lacked them. 2012-08-27 20:17:12 -04:00
tablefunc.sgml Revert: In docs, change a few cases of "not important" to 2012-08-16 11:26:40 -04:00
tcn.sgml Reduce messages about implicit indexes and sequences to DEBUG1. 2012-07-04 20:35:29 -04:00
test-parser.sgml
textsearch.sgml Fix typo: lexemes misspelled in full text search docs. 2012-09-11 19:46:17 -05:00
trigger.sgml Fix trigger example code to match header changes 2012-03-20 16:50:18 -03:00
tsearch2.sgml
typeconv.sgml Extend the unknowns-are-same-as-known-inputs type resolution heuristic. 2011-11-17 18:28:41 -05:00
unaccent.sgml
user-manag.sgml Make superuser imply replication privilege. The idea of a privilege that 2012-01-14 18:22:16 +02:00
uuid-ossp.sgml
vacuumlo.sgml Make documentation of --help and --version options more consistent 2012-06-18 02:46:59 +03:00
wal.sgml Update URLs that pointed to sun.com; either repoint them or remove 2012-09-02 09:16:26 -04:00
xaggr.sgml Remove spclocation field from pg_tablespace 2011-12-07 10:37:33 +01:00
xfunc.sgml More documentation updates for LATERAL. 2012-09-01 00:40:25 -04:00
xindex.sgml Add SP-GiST (space-partitioned GiST) index access method. 2011-12-17 16:42:30 -05:00
xml2.sgml Prevent access to external files/URLs via contrib/xml2's xslt_process(). 2012-08-14 18:31:18 -04:00
xoper.sgml
xplang.sgml
xtypes.sgml

<!-- doc/src/sgml/README.links -->

Linking within SGML documents can be confusing, so here is a summary:


Intra-document Linking
----------------------

<xref>
	use to get chapter/section # from the title of the target
	link, or xreflabel if defined at the target; has no close tag
	http://www.oasis-open.org/docbook/documentation/reference/html/xref.html

<link>
	use to supply text for the link, requires </link>
	http://www.oasis-open.org/docbook/documentation/reference/html/link.html

linkend=
	controls the target of the link/xref, required

endterm=
	for <xref>, allows the text of the link/xref to be taken from a
	different link target title


External Linking
----------------

<ulink>
	like <link>, but uses a URL (not a document target);  requires
	</ulink>; if no text is specified, the URL appears as the link
	text
	http://www.oasis-open.org/docbook/documentation/reference/html/ulink.html

url=
	used by <ulink> to specify the URL, required


Guidelines
----------

o  If you want to supply text, use <link>, else <xref>
o  Do not use text with <ulink> so the URL appears in printed output
o  Specific nouns like GUC variables, SQL commands, and contrib modules
   usually have xreflabels