delta/postgresql.git/doc/src/sgml/oid2name.sgml, branch master git.postgresql.org: git/postgresql.git Doc: fix some description of environment variables with frontend tools 2020-03-09T01:53:22+00:00 Michael Paquier michael@paquier.xyz 2020-03-09T01:53:22+00:00 5aaa584f819e2d8d2fb23cdf2174ce6e5628e1f5 This addresses a couple of issues in the documentation: - Description of PG_COLOR was missing for some tools (pg_archivecleanup and pg_test_fsync), while the other descriptions had grammar mistakes. - pgbench supports more environment variables: PGUSER, PGHOST and PGPORT. - vacuumlo, oid2name and pgbench support coloring (HEAD only) Author: Michael Paquier Reviewed-by: Fabien Coelho, Daniel Gustafsson, Juan José Santamaría Flecha Discussion: https://postgr.es/m/20200304075418.GJ2593@paquier.xyz Backpatch-through: 12 
This addresses a couple of issues in the documentation:
- Description of PG_COLOR was missing for some tools (pg_archivecleanup
and pg_test_fsync), while the other descriptions had grammar mistakes.
- pgbench supports more environment variables: PGUSER, PGHOST and
PGPORT.
- vacuumlo, oid2name and pgbench support coloring (HEAD only)

Author: Michael Paquier
Reviewed-by: Fabien Coelho, Daniel Gustafsson, Juan José Santamaría
Flecha
Discussion: https://postgr.es/m/20200304075418.GJ2593@paquier.xyz
Backpatch-through: 12
Rework option set of oid2name 2018-08-28T12:33:32+00:00 Michael Paquier michael@paquier.xyz 2018-08-28T12:33:32+00:00 1aaf532deabfa356c99abc80fc78d988ad1f1355 oid2name has done little effort to keep an interface consistent with other binary utilities: - -H was used instead of -h/-host. This option is now marked as deprecated, still its output is accepted to be backward-compatible. - -P has been removed from the code, and was still documented. - All options gain long aliases, making connection options more similar to other binaries. - Document environment variables which could be used: PGHOST, PGPORT and PGUSER. A basic set of TAP tests is added on the way, and documentation is cleaned up to be more consistent with other things. Author: Tatsuro Yamada Reviewed-by: Michael Paquier Discussion: https://postgr.es/m/c7e7f25c-1747-cd0f-9335-390bc97b2db5@lab.ntt.co.jp 
oid2name has done little effort to keep an interface consistent with
other binary utilities:
- -H was used instead of -h/-host.  This option is now marked as
deprecated, still its output is accepted to be backward-compatible.
- -P has been removed from the code, and was still documented.
- All options gain long aliases, making connection options more similar
to other binaries.
- Document environment variables which could be used: PGHOST, PGPORT and
PGUSER.

A basic set of TAP tests is added on the way, and documentation is
cleaned up to be more consistent with other things.

Author: Tatsuro Yamada
Reviewed-by: Michael Paquier
Discussion: https://postgr.es/m/c7e7f25c-1747-cd0f-9335-390bc97b2db5@lab.ntt.co.jp
Convert documentation to DocBook XML 2017-11-23T14:44:28+00:00 Peter Eisentraut peter_e@gmx.net 2017-11-23T14:39:47+00:00 3c49c6facb22cdea979f5d1465ba53f972d32163 Since some preparation work had already been done, the only source changes left were changing empty-element tags like <xref linkend="foo"> to <xref linkend="foo"/>, and changing the DOCTYPE. The source files are still named *.sgml, but they are actually XML files now. Renaming could be considered later. In the build system, the intermediate step to convert from SGML to XML is removed. Everything is build straight from the source files again. The OpenSP (or the old SP) package is no longer needed. The documentation toolchain instructions are updated and are much simpler now. Peter Eisentraut, Alexander Lakhin, Jürgen Purtz 
Since some preparation work had already been done, the only source
changes left were changing empty-element tags like <xref linkend="foo">
to <xref linkend="foo"/>, and changing the DOCTYPE.

The source files are still named *.sgml, but they are actually XML files
now.  Renaming could be considered later.

In the build system, the intermediate step to convert from SGML to XML
is removed.  Everything is build straight from the source files again.
The OpenSP (or the old SP) package is no longer needed.

The documentation toolchain instructions are updated and are much
simpler now.

Peter Eisentraut, Alexander Lakhin, Jürgen Purtz
Don't use SGML empty tags 2017-10-17T19:10:33+00:00 Peter Eisentraut peter_e@gmx.net 2017-10-09T01:44:17+00:00 c29c578908dc0271eeb13a4014e54bff07a29c05 For DocBook XML compatibility, don't use SGML empty tags (</>) anymore, replace by the full tag name. Add a warning option to catch future occurrences. Alexander Lakhin, Jürgen Purtz 
For DocBook XML compatibility, don't use SGML empty tags (</>) anymore,
replace by the full tag name.  Add a warning option to catch future
occurrences.

Alexander Lakhin, Jürgen Purtz
doc: Improve DocBook XML validity 2014-02-24T02:31:08+00:00 Peter Eisentraut peter_e@gmx.net 2014-02-24T02:25:35+00:00 bb4eefe7bf518e42c73797ea37b033a5d8a8e70a DocBook XML is superficially compatible with DocBook SGML but has a slightly stricter DTD that we have been violating in a few cases. Although XSLT doesn't care whether the document is valid, the style sheets don't necessarily process invalid documents correctly, so we need to work toward fixing this. This first commit moves the indexterms in refentry elements to an allowed position. It has no impact on the output. 
DocBook XML is superficially compatible with DocBook SGML but has a
slightly stricter DTD that we have been violating in a few cases.
Although XSLT doesn't care whether the document is valid, the style
sheets don't necessarily process invalid documents correctly, so we need
to work toward fixing this.

This first commit moves the indexterms in refentry elements to an
allowed position.  It has no impact on the output.
Make documentation of --help and --version options more consistent 2012-06-17T23:46:59+00:00 Peter Eisentraut peter_e@gmx.net 2012-06-17T23:44:00+00:00 bb7520cc26dcd392e3dce294b685b3a0d6dae9e9 Before, some places didn't document the short options (-? and -V), some documented both, some documented nothing, and they were listed in various orders. Now this is hopefully more consistent and complete. 
Before, some places didn't document the short options (-? and -V),
some documented both, some documented nothing, and they were listed in
various orders.  Now this is hopefully more consistent and complete.
Some reference page improvements 2012-05-19T22:15:55+00:00 Peter Eisentraut peter_e@gmx.net 2012-05-19T22:15:55+00:00 fe2534e534c0572a71d6f0d2d51a2d058fc3524c initdb: Add -T option oid2name: Put options in some non-random order pg_dump: Put --section option in the right place And some additional markup and terminology improvements. 
initdb: Add -T option
oid2name: Put options in some non-random order
pg_dump: Put --section option in the right place

And some additional markup and terminology improvements.
Split contrib documentation into extensions and programs 2012-05-09T17:39:53+00:00 Peter Eisentraut peter_e@gmx.net 2012-05-09T17:39:53+00:00 1c882e07da553d792f479beb92b4729a4c0bd8de Create separate appendixes for contrib extensions and other server plugins on the one hand, and utility programs on the other. Recast the documentation of the latter as refentries, so that man pages are generated. 
Create separate appendixes for contrib extensions and other server
plugins on the one hand, and utility programs on the other.  Recast
the documentation of the latter as refentries, so that man pages are
generated.
Add xreflabels to /contrib manuals so links appear correct. Also update 2011-05-08T02:29:20+00:00 Bruce Momjian bruce@momjian.us 2011-05-08T02:29:20+00:00 e567c9ff3409203a3ab50a2ff87cdab73bef6313 README.links to explain xref properly. 
README.links to explain xref properly.
Remove cvs keywords from all files. 2010-09-20T20:08:53+00:00 Magnus Hagander magnus@hagander.net 2010-09-20T20:08:53+00:00 9f2e211386931f7aee48ffbc2fcaef1632d8329f