DG2.3. 文档源码
文档源码包括纯文本文件、手册页和 html。不过,Postgres 的新文档大多将使用标准通用标记语言(SGML) DocBook 文档类型定义(DTD)编写。现有文档的大部分已经或将被转换为 SGML。
SGML 的目的是让作者能够指定文档的结构和内容(例如使用 DocBook DTD),并由文档样式定义这些内容如何被渲染成最终形式(例如使用 Norm Walsh 的样式表)。
文档积累自多个来源。随着我们把现有文档整合成一个连贯的文档集,较旧的版本将逐渐过时,并会从发行包中删除。但是,这不会立即发生,也不会同时发生在所有文档上。为了简化过渡,并帮助引导开发者和作者,我们定义了一份过渡路线图。
下面是 v6.5 的文档计划:
开始为用户指南和管理员指南编制索引信息。
为用户指南编写更多涵盖参考页之外领域的章节。这将包括入门信息,以及对典型设计问题处理方法的建议。
把现有手册页中的信息合并到参考页和用户指南中。将手册页压缩成提示性信息,并附上指向主文档集的参考。
把新的 sgml 参考页转换为新的手册页,替换现有手册页。
出于可移植性考虑,把所有图形源文件转换为 CGM 格式文件。目前我们大多只有 Applix Graphics 源文件,可以由它们生成 .gif 输出。有一幅图只有 .gif 和 .ps 格式可用,应当重画或删除。
DG2.3.1. 文档结构
目前有五份用 DocBook 编写的独立文档。每份文档都有一个容器源文档,它定义 DocBook 环境和其他文档源文件。这些主源文件位于
doc/src/sgml/,文档使用的许多其他源文件也在那里。主源文件有:
- postgres.sgml
这是集成文档,把所有其他文档作为部分包含在内。它以 HTML 格式生成输出,因为浏览器界面让你只需点击就能在全部文档之间轻松跳转。其他文档同时提供 HTML 和硬拷贝两种格式。
- tutorial.sgml
入门教程,带示例。不包括编程主题,旨在帮助不熟悉 SQL 的读者。这是“入门”文档。
- user.sgml
用户指南。包括数据类型和用户级接口的信息。这是放置“为什么”类信息的地方。
- reference.sgml
参考手册。包括 Postgres SQL 语法。这是放置“怎么做”类信息的地方。
- programming.sgml
程序员指南。包括 Postgres 可扩展性以及编程接口的信息。
- admin.sgml
管理员指南。包括安装说明和发行说明。
DG2.3.2. 文档文件
表 DG2.2. Postgres 文档源码
| 文件 | 状态 | |
|---|---|---|
| ./doc/src/graphics/catalogs.gif | 输出文件 | |
| ./doc/src/graphics/clientserver.ag | 源文件。转换为 CGM | |
| ./doc/src/graphics/clientserver.gif | 输出文件 | |
| ./doc/src/graphics/connections.ag | 源文件。转换为 CGM | |
| ./doc/src/graphics/connections.gif | 输出文件 | |
| ./doc/src/graphics/layout.ag | 源文件。转换为 CGM | |
| ./doc/src/graphics/layout.gif | 输出文件 | |
| ./doc/src/sgml/about.sgml | 新文档 | |
| ./doc/src/sgml/admin.sgml | 管理员指南容器 | |
| ./doc/src/sgml/advanced.sgml | 已转换 | |
| ./doc/src/sgml/arch-dev.sgml | 已转换 | |
| ./doc/src/sgml/arch-pg.sgml | 已转换 | |
| ./doc/src/sgml/arch.sgml | 已转换 | |
| ./doc/src/sgml/array.sgml | 已转换 | |
| ./doc/src/sgml/biblio.sgml | 新文档 | |
| ./doc/src/sgml/bki.sgml | 从 bki.5 转换 | |
| ./doc/src/sgml/compiler.sgml | 新文档 | |
| ./doc/src/sgml/config.sgml | 新文档 | |
| ./doc/src/sgml/contacts.sgml | 文档贡献者?未使用。要么完成要么丢弃 | |
| ./doc/src/sgml/datatype.sgml | 新文档 | |
| ./doc/src/sgml/dfunc.sgml | 已转换 | |
| ./doc/src/sgml/docguide.sgml | 文档信息。新文档 | |
| ./doc/src/sgml/ecpg.sgml | ecpg eSQL 预编译器文档 | |
| ./doc/src/sgml/environ.sgml | 已转换 | |
| ./doc/src/sgml/extend.sgml | 已转换 | |
| ./doc/src/sgml/func-ref.sgml | 已转换 | |
| ./doc/src/sgml/func.sgml | 已转换 | |
| ./doc/src/sgml/geqo.sgml | GEQO 遗传优化器文档 | |
| ./doc/src/sgml/gist.sgml | 来自邮件列表的新文档 | |
| ./doc/src/sgml/history.sgml | 新文档 | |
| ./doc/src/sgml/indices.sgml | 新文档 | |
| ./doc/src/sgml/info.sgml | 新文档 | |
| ./doc/src/sgml/inherit.sgml | 已转换 | |
| ./doc/src/sgml/install.sgml | 安装说明 | |
| ./doc/src/sgml/intro-ag.sgml | 管理员指南引言。已转换 | |
| ./doc/src/sgml/intro-pg.sgml | 程序员指南引言。已转换 | |
| ./doc/src/sgml/intro.sgml | 用户指南引言 | |
| ./doc/src/sgml/jdbc.sgml | 来自 Peter Mount 的新文档 | |
| ./doc/src/sgml/keys.sgml | 新文档 | |
| ./doc/src/sgml/legal.sgml | 供引言使用的版权等 | |
| ./doc/src/sgml/libpgtcl.sgml | 已转换 | |
| ./doc/src/sgml/libpq++.sgml | C++ 库。已转换 | |
| ./doc/src/sgml/libpq.sgml | C 库 | |
| ./doc/src/sgml/lobj.sgml | 大对象 | |
| ./doc/src/sgml/manage.sgml | 已转换 | |
| ./doc/src/sgml/notation.sgml | 供引言使用的文档记号 | |
| ./doc/src/sgml/odbc.sgml | ODBC 驱动 | |
| ./doc/src/sgml/oper.sgml | 已转换 | |
| ./doc/src/sgml/page.sgml | 磁盘存储方案 | |
| ./doc/src/sgml/pg_options.sgml | 后端配置 | |
| ./doc/src/sgml/pgaccess.sgml | 已转换 | |
| ./doc/src/sgml/ports.sgml | 支持/不支持的平台 | |
| ./doc/src/sgml/postgres.sgml | 全部文档的容器。最适合 html 输出 | |
| ./doc/src/sgml/programmer.sgml | 程序员指南 | |
| ./doc/src/sgml/protocol.sgml | 已转换 | |
| ./doc/src/sgml/psql.sgml | 已转换 | |
| ./doc/src/sgml/query-ug.sgml | 已转换 | |
| ./doc/src/sgml/query.sgml | 已转换 | |
| ./doc/src/sgml/recovery.sgml | 数据库恢复 | |
| ./doc/src/sgml/reference.sgml | 已转换 | |
| ./doc/src/sgml/regress.sgml | 回归测试 | |
| ./doc/src/sgml/release.sgml | 已转换 | |
| ./doc/src/sgml/rules.sgml | 规则系统 | |
| ./doc/src/sgml/runtime.sgml | 运行时环境。v6.4 新增 | |
| ./doc/src/sgml/security.sgml | 服务器安全 | |
| ./doc/src/sgml/signals.sgml | 后端的系统信号。 | |
| ./doc/src/sgml/spi.sgml | 已转换。原件已删除 | |
| ./doc/src/sgml/start-ag.sgml | 已转换 | |
| ./doc/src/sgml/start.sgml | 已转换 | |
| ./doc/src/sgml/storage.sgml | 已转换 | |
| ./doc/src/sgml/syntax.sgml | SQL 语法。在 UG 中 | |
| ./doc/src/sgml/trigger.sgml | 已转换 | |
| ./doc/src/sgml/tutorial.sgml | 教程容器 | |
| ./doc/src/sgml/typeconv.sgml | 数据类型转换。v6.4 新增。在 UG 中 | |
| ./doc/src/sgml/user.sgml | 用户指南 | |
| ./doc/src/sgml/xaggr.sgml | 已转换 | |
| ./doc/src/sgml/xfunc.sgml | 已转换 | |
| ./doc/src/sgml/xindex.sgml | 已转换 | |
| ./doc/src/sgml/xoper.sgml | 已转换 | |
| ./doc/src/sgml/xplang.sgml | 编程语言。v6.4 新增 | |
| ./doc/src/sgml/xtypes.sgml | 已转换 | |
| ./doc/src/sgml/y2k.sgml | Y2K 声明。v6.4 新增 | |
| ./doc/src/sgml/ref/abort.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/allfiles.sgml | ref/ 中的文件列表(内部) | |
| ./doc/src/sgml/ref/alter_table.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/alter_user.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/begin.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/close.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/cluster.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/commands.sgml | 命令列表(内部) | |
| ./doc/src/sgml/ref/commit.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/copy.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/create_aggregate.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/create_database.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/create_function.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/create_index.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/create_language.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/create_operator.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/create_rule.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/create_sequence.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/create_table.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/create_trigger.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/create_type.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/create_user.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/create_view.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/createdb.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/createuser.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/declare.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/delete.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/destroydb.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/destroyuser.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/drop_aggregate.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/drop_database.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/drop_function.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/drop_index.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/drop_language.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/drop_operator.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/drop_rule.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/drop_sequence.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/drop_table.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/drop_trigger.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/drop_type.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/drop_user.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/drop_view.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/explain.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/fetch.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/grant.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/initdb.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/initlocation.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/insert.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/listen.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/load.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/lock.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/move.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/notify.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/pg_dump.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/pg_dumpall.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/psql-ref.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/reset.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/revoke.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/rollback.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/select.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/set.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/show.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/update.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/vacuum.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/unlisten.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/vacuumdb.sgml | v6.4 新增 | |
| ./doc/src/sgml/ref/pg_upgrade.sgml | v6.4 新增 |
DG2.3.3. 文档转换
表 DG2.3. Postgres 文档源码
| 文件 | 状态 | |
|---|---|---|
| ./HISTORY | 已过时。转换为 release.sgml | |
| ./README | 未转换 | |
| ./INSTALL | 已过时。转换为 install.sgml | |
| ./contrib/README | 未转换 | |
| ./contrib/apache_logging/README | 未转换 | |
| ./contrib/array/array_iterator.doc | 未转换 | |
| ./contrib/datetime/datetime_functions.doc | 未转换 | |
| ./contrib/earthdistance/README | 未转换 | |
| ./contrib/int8/README | 未转换 | |
| ./contrib/ip_and_mac/README | 未转换 | |
| ./contrib/lo/README | 未转换 | |
| ./contrib/mSQL-interface/README | 未转换 | |
| ./contrib/noupdate/noup.example | 未转换 | |
| ./contrib/pginterface/README | 未转换 | |
| ./contrib/sequence/set_sequence.sql.in | 未转换 | |
| ./contrib/soundex/soundex.sql.in | 未转换 | |
| ./contrib/spi/README | 未转换 | |
| ./contrib/spi/autoinc.example | 未转换 | |
| ./contrib/spi/insert_username.example | 未转换 | |
| ./contrib/spi/refint.example | 未转换 | |
| ./contrib/spi/timetravel.example | 未转换 | |
| ./contrib/string/string_io.sql.in | 未转换 | |
| ./contrib/unixdate/unixdate.sql | 未转换 | |
| ./contrib/userlock/user_locks.doc | 未转换 | |
| ./doc/FAQ | 未转换 | |
| ./doc/FAQ_DEV | 未转换 | |
| ./doc/FAQ_FreeBSD | 未转换 | |
| ./doc/FAQ_Irix | 未转换 | |
| ./doc/FAQ_Linux | 未转换 | |
| ./doc/TODO | 未转换 | |
| ./doc/README.GEQO | 已删除。被 geqo.sgml 取代 | |
| ./doc/README.fsync | 并入管理员指南 | |
| ./doc/README.locale | 并入管理员指南 | |
| ./doc/README.mb | 并入管理员指南 | |
| ./doc/README.mb.jp | 未转换 | |
| ./doc/README.support | 未转换 | |
| ./doc/TODO.GEQO | 已删除。被 geqo.sgml 取代 | |
| ./doc/userguide.ps | 已删除(转换为 SGML) | |
| ./src/DEVELOPERS | 未转换 | |
| ./src/backend/access/nbtree/README | 未转换 | |
| ./src/backend/catalog/README | 未转换 | |
| ./src/backend/libpq/pg_hba.conf.sample | 未转换 | |
| ./src/backend/libpq/pg_ident.conf.sample | 未转换 | |
| ./src/backend/nodes/README | 未转换 | |
| ./src/backend/optimizer/README | 未转换 | |
| ./src/backend/optimizer/geqo/pg_geqo.sample | 未转换 | |
| ./src/backend/optimizer/plan/README | 未转换 | |
| ./src/backend/parser/README | 未转换 | |
| ./src/backend/port/dynloader/README.dlfcn.aix | 未转换 | |
| ./src/backend/regex/COPYRIGHT | 未转换 | |
| ./src/backend/regex/WHATSNEW | 未转换 | |
| ./src/backend/regex/re_format.7 | 未转换 | |
| ./src/backend/regex/regex.3 | 未转换 | |
| ./src/backend/storage/ipc/README | 未转换 | |
| ./src/backend/storage/lmgr/README | 未转换 | |
| ./src/backend/storage/smgr/README | 未转换 | |
| ./src/bin/pg_dump/README | 未转换 | |
| ./src/bin/pgaccess/README.pga | 未转换 | |
| ./src/bin/pgaccess/formdemo.sql | 未转换 | |
| ./src/bin/pgtclsh/README | 未转换 | |
| ./src/data/charset.conf | 未转换 | |
| ./src/data/koi-alt.tab | 未转换 | |
| ./src/data/koi-iso.tab | 未转换 | |
| ./src/data/koi-koi.tab | 未转换 | |
| ./src/data/koi-mac.tab | 未转换 | |
| ./src/data/koi-win.tab | 未转换 | |
| ./src/interfaces/ecpg/ChangeLog | 未转换 | |
| ./src/interfaces/ecpg/TODO | 未转换 | |
| ./src/interfaces/jdbc/README | 未转换 | |
| ./src/interfaces/jdbc/README_6.3 | 未转换 | |
| ./src/interfaces/jdbc/example/ImageViewer.java | 未转换 | |
| ./src/interfaces/jdbc/example/basic.java | 未转换 | |
| ./src/interfaces/jdbc/example/blobtest.java | 未转换 | |
| ./src/interfaces/jdbc/example/datestyle.java | 未转换 | |
| ./src/interfaces/jdbc/example/psql.java | 未转换 | |
| ./src/interfaces/libpgtcl/README | 未转换 | |
| ./src/interfaces/libpq/README | 未转换 | |
| ./src/interfaces/libpq++/README | 未转换 | |
| ./src/interfaces/libpq++/examples/testlibpq0.cc | 未转换 | |
| ./src/interfaces/libpq++/examples/testlibpq1.cc | 未转换 | |
| ./src/interfaces/libpq++/examples/testlibpq2.cc | 未转换 | |
| ./src/interfaces/libpq++/examples/testlibpq2.sql | 未转换 | |
| ./src/interfaces/libpq++/examples/testlibpq3.cc | 未转换 | |
| ./src/interfaces/libpq++/examples/testlibpq3.sql | 未转换 | |
| ./src/interfaces/libpq++/examples/testlibpq4.cc | 未转换 | |
| ./src/interfaces/libpq++/examples/testlibpq4.sql | 未转换 | |
| ./src/interfaces/libpq++/examples/testlibpq5.cc | 未转换 | |
| ./src/interfaces/libpq++/examples/testlibpq5.sql | 未转换 | |
| ./src/interfaces/libpq++/examples/testlibpq6.cc | 未转换 | |
| ./src/interfaces/libpq++/examples/testlo.cc | 未转换 | |
| ./src/interfaces/odbc/license.txt | 未转换 | |
| ./src/interfaces/odbc/notice.txt | 未转换 | |
| ./src/interfaces/odbc/readme.txt | 未转换 | |
| ./src/interfaces/perl5/MANIFEST | 未转换 | |
| ./src/interfaces/perl5/Changes | 未转换 | |
| ./src/interfaces/perl5/eg/example.newstyle | 未转换 | |
| ./src/interfaces/perl5/README | 未转换 | |
| ./src/interfaces/python/Announce | 未转换 | |
| ./src/interfaces/python/ChangeLog | 未转换 | |
| ./src/interfaces/python/README | 未转换 | |
| ./src/interfaces/python/tutorial/advanced.py | 未转换 | |
| ./src/interfaces/python/tutorial/advanced.pyc | 未转换 | |
| ./src/interfaces/python/tutorial/basics.py | 未转换 | |
| ./src/interfaces/python/tutorial/func.py | 未转换 | |
| ./src/interfaces/python/tutorial/func.pyc | 未转换 | |
| ./src/interfaces/python/tutorial/pgtools.py | 未转换 | |
| ./src/interfaces/python/tutorial/pgtools.pyc | 未转换 | |
| ./src/interfaces/python/tutorial/syscat.py | 未转换 | |
| ./src/interfaces/python/tutorial/syscat.pyc | 未转换 | |
| ./src/man/README | 未转换 | |
| ./src/man/abort.l | 未转换 | |
| ./src/man/alter_table.l | 未转换 | |
| ./src/man/alter_user.l | 拆分到参考手册和管理员指南 | |
| ./src/man/begin.l | 未转换 | |
| ./src/man/catalogs.3 | 目录概要。移到程序员指南? | |
| ./src/man/cleardbdir.1 | 未转换 | |
| ./src/man/close.l | 未转换 | |
| ./src/man/cluster.l | 未转换 | |
| ./src/man/commit.l | 未转换 | |
| ./src/man/copy.l | 未转换 | |
| ./src/man/create_aggregate.l | 未转换 | |
| ./src/man/create_database.l | 未转换 | |
| ./src/man/create_function.l | 未转换 | |
| ./src/man/create_index.l | 未转换 | |
| ./src/man/create_language.l | 未转换 | |
| ./src/man/create_operator.l | 未转换 | |
| ./src/man/create_rule.l | 未转换 | |
| ./src/man/create_sequence.l | 未转换 | |
| ./src/man/create_table.l | 未转换 | |
| ./src/man/create_trigger.l | 未转换 | |
| ./src/man/create_type.l | 未转换 | |
| ./src/man/create_user.l | 未转换 | |
| ./src/man/create_version.l | 未转换 | |
| ./src/man/create_view.l | 未转换 | |
| ./src/man/createdb.1 | 未转换 | |
| ./src/man/createuser.1 | 未转换 | |
| ./src/man/declare.l | 未转换 | |
| ./src/man/delete.l | 未转换 | |
| ./src/man/destroydb.1 | 未转换 | |
| ./src/man/destroyuser.1 | 未转换 | |
| ./src/man/drop.l | 未转换 | |
| ./src/man/drop_aggregate.l | 未转换 | |
| ./src/man/drop_database.l | 未转换 | |
| ./src/man/drop_function.l | 未转换 | |
| ./src/man/drop_index.l | 未转换 | |
| ./src/man/drop_language.l | 未转换 | |
| ./src/man/drop_operator.l | 未转换 | |
| ./src/man/drop_rule.l | 未转换 | |
| ./src/man/drop_sequence.l | 未转换 | |
| ./src/man/drop_table.l | 未转换 | |
| ./src/man/drop_trigger.l | 未转换 | |
| ./src/man/drop_type.l | 未转换 | |
| ./src/man/drop_user.l | 未转换 | |
| ./src/man/drop_view.l | 未转换 | |
| ./src/man/end.l | 未转换 | |
| ./src/man/ecpg.1 | 短手册页。保留 | |
| ./src/man/explain.l | 未转换 | |
| ./src/man/fetch.l | 未转换 | |
| ./src/man/grant.l | 未转换 | |
| ./src/man/initdb.1 | 未转换 | |
| ./src/man/initlocation.1 | 未转换 | |
| ./src/man/insert.l | 未转换 | |
| ./src/man/ipcclean.1 | 未转换 | |
| ./src/man/listen.l | 未转换 | |
| ./src/man/load.l | 未转换 | |
| ./src/man/lock.l | 未转换 | |
| ./src/man/move.l | 未转换 | |
| ./src/man/notify.l | 未转换 | |
| ./src/man/pg_dump.1 | 并入管理员指南 | |
| ./src/man/pg_dumpall.1 | 并入管理员指南 | |
| ./src/man/pg_upgrade.1 | 并入管理员指南 | |
| ./src/man/pg_hba.conf.5 | 并入管理员指南 | |
| ./src/man/pg_passwd.1 | 并入管理员指南 | |
| ./src/man/pgintro.1 | 并入用户指南? | |
| ./src/man/postgres.1 | 并入用户指南和管理员指南 | |
| ./src/man/postmaster.1 | 并入用户指南和管理员指南 | |
| ./src/man/psql.1 | 未转换 | |
| ./src/man/reset.l | 未转换 | |
| ./src/man/revoke.l | 未转换 | |
| ./src/man/rollback.l | 未转换 | |
| ./src/man/select.l | 未转换 | |
| ./src/man/set.l | 未转换 | |
| ./src/man/show.l | 未转换 | |
| ./src/man/sql.l | 未转换 | |
| ./src/man/update.l | 未转换 | |
| ./src/man/vacuum.l | 未转换 | |
| ./src/pl/tcl/INSTALL | 未转换 | |
| ./src/pl/tcl/modules/README | 未转换 | |
| ./src/pl/tcl/license.terms | 未转换 | |
| ./src/pl/tcl/test/README | 未转换 | |
| ./src/pl/tcl/test/runtest | 未转换 | |
| ./src/pl/tcl/test/test.expected | 未转换 | |
| ./src/pl/tcl/test/test_mklang.sql | 未转换 | |
| ./src/pl/tcl/test/test_queries.sql | 未转换 | |
| ./src/pl/tcl/test/test_setup.sql | 未转换 | |
| ./src/test/bench/WISC-README | 未转换 | |
| ./src/test/locale/README | 未转换 | |
| ./src/test/performance/results/PgSQL.970926 | 未转换 | |
| ./src/test/regress/README | 未转换 | |
| ./src/test/suite/README | 未转换 | |
| ./src/tools/RELEASE_CHANGES | 未转换 | |
| ./src/tools/SQL_keywords | 未转换 | |
| ./src/tools/backend/README | 未转换 | |
| ./src/tools/backend/flow.fig | 未转换 | |
| ./src/tools/backend/flow.jpg | 未转换 | |
| ./src/tools/make_keywords.README | 未转换 | |
| ./src/tools/entab/entab.man | 未转换 | |
| ./src/tools/make_diff/README | 未转换 | |
| ./src/tools/mkldexport/README | 未转换 | |
| ./src/tools/pgindent/README | 未转换 | |
| ./src/tutorial/README | 未转换 | |
| ./src/utils/README | 未转换 | |
| ./lib/pg_hba.conf.sample | 未转换 | |
| ./lib/pg_geqo.sample | 未转换 |
DG2.3.4. 样式与约定
DocBook 有一组丰富的标签和构造,其中直接而明显地适用于良构文档的百分比出人意料地高。Postgres 文档集最近才改写为 SGML,不久将来会从文档集中选出若干节,作为 DocBook 用法的示范性示例加以维护。此外,下面还会给出 DocBook 标签的简短摘要。
DG2.3.5. SGML 编写工具
当前的 Postgres 文档集是使用纯文本编辑器(或 emacs/psgml,见下文)编写的,内容用 SGML DocBook 标记。
SGML 和 DocBook 的开源编写工具并不多。最常见的工具集是带 psgml 功能扩展的 emacs/xemacs 编辑软件包。在某些系统(例如 RedHat Linux)上,典型的完整安装会包含这些工具。
DG2.3.5.1. emacs/psgml
emacs(以及 xemacs)有一种 SGML 主模式。正确配置后,它可以让你用 emacs 插入标签并检查标记的一致性。
把以下内容放入你的 ~/.emacs
环境文件:
; ********** for SGML mode (psgml)
(setq sgml-catalog-files "/usr/lib/sgml/CATALOG")
(setq sgml-local-catalogs "/usr/lib/sgml/CATALOG")
(autoload 'sgml-mode "psgml" "Major mode to edit SGML files." t )
并在同一文件中为 SGML 向(已有的)auto-mode-alist 定义中加入一项:
(setq
auto-mode-alist
'(("\\.sgml$" . sgml-mode)
))
每个 SGML 源文件的末尾都有下面这一块:
!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"./reference.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:"/usr/lib/sgml/catalog"
sgml-local-ecat-files:nil
End:
--
Postgres 发行包中包含一个已解析的 DTD 定义文件 reference.ced。你可能会发现
使用 emacs/psgml 时,处理这些分别保存书籍各部分的文件,有一种方便的方式:在编辑时插入适当的 DOCTYPE 声明。例如,当前这个源码文件是一章附录,因此可以将它指定为 DocBook 文档的“appendix”实例,把第一行写成这样:
!doctype appendix PUBLIC "-//Davenport//DTD DocBook V3.0//EN"
这意味着任何读取 SGML 的东西都能正确处理它,而且我可以用“nsgmls -s docguide.sgml”验证该文档。