Re: PostgreSQL 7.2 docs

Started by Bruce Momjianabout 24 years ago13 messagesdocs
Jump to latest
#1Bruce Momjian
bruce@momjian.us

Answering questions from DOSSIER creator. Feel free to chime in.

Rich Morin wrote:

I'm looking into doing a set of DOSSIER volumes for 7.2 and I'd like to
know the nature of and relationship between some of the docs. If you
can help, please do so. In any case, please feel free to forward this
note as appropriate.

OK, done. CC'ing to docs.

The archive .../doc/man.tar.gz contains two directories of man pages.
Are these simply reformatted versions of sections I and II from the
Reference Manual?

These are just the reference manual pages, formatted into Unix manual
page format, so people can do 'man insert'.

The archive .../doc/postgres.tar.gz contains one (huge) directory of
HTML pages. Looking at the index.html file, it appears that many (if
not all) of the files are are simply reformatted versions of other
documents. Is this the case? Is there a subset of these pages that
it would make sense to print up, in addition to the other documents?

Yes, postgres.tar.gz is the mega-manual, while we also distribute the
seconds separately, e.g. admin, reference, etc.

IIRC, The 7.1 distribution contained a paper called internals.ps, but
I don't see this in the 7.2 distribution. Wazzup?

We removed it and put it on the developers page. We decided it didn't
belong in the CVS or tarball.

Finally, if there are any other documents that you would like to see
me include in a DOSSIER volume, please let me know!

I will throw this question out to the group.

-- 
  Bruce Momjian                        |  http://candle.pha.pa.us
  pgman@candle.pha.pa.us               |  (610) 853-3000
  +  If your life is a hard drive,     |  830 Blythe Avenue
  +  Christ can be your backup.        |  Drexel Hill, Pennsylvania 19026
#2Peter Eisentraut
peter_e@gmx.net
In reply to: Bruce Momjian (#1)

Bruce Momjian writes:

Rich Morin wrote:

I'm looking into doing a set of DOSSIER volumes for 7.2 and I'd like to
know the nature of and relationship between some of the docs.

There's an attempt to explain this here:

http://www.us.postgresql.org/users-lounge/docs/7.2/postgres/docguide.html

The archive .../doc/man.tar.gz contains two directories of man pages.
Are these simply reformatted versions of sections I and II from the
Reference Manual?

Sections I, II, and III. In other words, there's nothing in the man pages
that you don't see in the HTML version or in any other format.

The archive .../doc/postgres.tar.gz contains one (huge) directory of
HTML pages. Looking at the index.html file, it appears that many (if
not all) of the files are are simply reformatted versions of other
documents. Is this the case?

It is in the nature of the way we maintain and format our documentation
that any format can be viewed as a reformatted version of another format.
See also under the link posted above.

Is there a subset of these pages that
it would make sense to print up, in addition to the other documents?

All of these pages are theoretically worth printing. Not sure what "other
documents" you are referring to. If there are any, then there's something
wrong.

--
Peter Eisentraut peter_e@gmx.net

#3Rich Morin
rdm@cfcl.com
In reply to: Peter Eisentraut (#2)

At 5:38 PM -0500 2/26/02, Peter Eisentraut wrote:

It is in the nature of the way we maintain and format our documentation
that any format can be viewed as a reformatted version of another format.

So, if I'm printing the PostgreSQL "books", FAQs, and the "internals.ps"
file, I've got things pretty well covered.

All of these pages are theoretically worth printing. Not sure what "other
documents" you are referring to. If there are any, then there's something
wrong.

There might be some (e.g., historic) papers that aren't in the distro for
some reason, but would be interesting for some folks to have. Can't hurt
to ask...

-r
--
email: rdm@cfcl.com; phone: +1 650-873-7841
http://www.cfcl.com/rdm - my home page, resume, etc.
http://www.cfcl.com/Meta - The FreeBSD Browser, Meta Project, etc.
http://www.ptf.com/dossier - Prime Time Freeware's DOSSIER series
http://www.ptf.com/tdc - Prime Time Freeware's Darwin Collection

#4Peter Eisentraut
peter_e@gmx.net
In reply to: Rich Morin (#3)

Rich Morin writes:

At 5:38 PM -0500 2/26/02, Peter Eisentraut wrote:

It is in the nature of the way we maintain and format our documentation
that any format can be viewed as a reformatted version of another format.

So, if I'm printing the PostgreSQL "books", FAQs, and the "internals.ps"
file, I've got things pretty well covered.

Well, the internals.ps paper was removed for a reason, so I'd advise you
not to print it.

The FAQ's are the only thing that seem to escape the unified DocBook
source for some reason.

Btw., how do you plan to format the material for printing?

--
Peter Eisentraut peter_e@gmx.net

#5Rich Morin
rdm@cfcl.com
In reply to: Peter Eisentraut (#4)

At 7:23 PM -0500 2/26/02, Peter Eisentraut wrote:

Well, the internals.ps paper was removed for a reason, so I'd advise
you not to print it.

And that reason would be??? Seriously, it seems like a useful paper;
even if it isn't needed in the distribution, it may be worth printing.

Btw., how do you plan to format the material for printing?

I turn all material into PostScript, using whichever tool( chain)s seem
appropriate. I then run the PostScript files through a Perl script
which scales, translates, and adds descriptive footers. Finally, I
prepend some "front matter" (e.g., TOC, Preface) and concatenate the
result into a single PostScript document, which I "distill" into PDF
and send off to the printing firm, along with the volume's cover art.

The current set of PostgreSQL volumes used the distributed PostScript
files for the 7.1 books; the upcoming set will probably start from PDF
files, converted to PostScript by Adobe Acrobat (i.e., "Print to File").
I format the ASCII FAQs using a2ps (and a bunch of options :-).

-r

P.S. There is no entry for pgsql-docs on the "User's Lounge" web page,
so I can't subscribe. Also, there is a formatting error in the
HTML for the "pgsql-sql" entry on the page:

[archives pgsql-sql - This is a discussion area ...
]
--
email: rdm@cfcl.com; phone: +1 650-873-7841
http://www.cfcl.com/rdm - my home page, resume, etc.
http://www.cfcl.com/Meta - The FreeBSD Browser, Meta Project, etc.
http://www.ptf.com/dossier - Prime Time Freeware's DOSSIER series
http://www.ptf.com/tdc - Prime Time Freeware's Darwin Collection

#6Peter Eisentraut
peter_e@gmx.net
In reply to: Rich Morin (#5)

Rich Morin writes:

At 7:23 PM -0500 2/26/02, Peter Eisentraut wrote:

Well, the internals.ps paper was removed for a reason, so I'd advise
you not to print it.

And that reason would be??? Seriously, it seems like a useful paper;
even if it isn't needed in the distribution, it may be worth printing.

It doesn't correspond to reality any longer.

--
Peter Eisentraut peter_e@gmx.net

#7Vince Vielhaber
vev@michvhf.com
In reply to: Rich Morin (#5)

On Tue, 26 Feb 2002, Rich Morin wrote:

P.S. There is no entry for pgsql-docs on the "User's Lounge" web page,
so I can't subscribe. Also, there is a formatting error in the
HTML for the "pgsql-sql" entry on the page:

It's a developer's list. Go to the developer's website and subscribe.

Vince.
--
==========================================================================
Vince Vielhaber -- KA8CSH email: vev@michvhf.com http://www.pop4.net
56K Nationwide Dialup from $16.00/mo at Pop4 Networking
Online Campground Directory http://www.camping-usa.com
Online Giftshop Superstore http://www.cloudninegifts.com
==========================================================================

#8Bruce Momjian
bruce@momjian.us
In reply to: Rich Morin (#5)

Rich Morin wrote:

At 7:23 PM -0500 2/26/02, Peter Eisentraut wrote:

Well, the internals.ps paper was removed for a reason, so I'd advise
you not to print it.

And that reason would be??? Seriously, it seems like a useful paper;
even if it isn't needed in the distribution, it may be worth printing.

I just bloated the tarball and wasn't really for general consuption.

P.S. There is no entry for pgsql-docs on the "User's Lounge" web page,
so I can't subscribe. Also, there is a formatting error in the
HTML for the "pgsql-sql" entry on the page:

Docs mailing list is in the developer's lounge.

[archives pgsql-sql - This is a discussion area ...
]

I don't see the problem. Looks fine here.

-- 
  Bruce Momjian                        |  http://candle.pha.pa.us
  pgman@candle.pha.pa.us               |  (610) 853-3000
  +  If your life is a hard drive,     |  830 Blythe Avenue
  +  Christ can be your backup.        |  Drexel Hill, Pennsylvania 19026
#9Rich Morin
rdm@cfcl.com
In reply to: Bruce Momjian (#8)

At 2:40 PM -0500 3/1/02, Bruce Momjian wrote:

Rich Morin wrote:

At 7:23 PM -0500 2/26/02, Peter Eisentraut wrote:

Well, the internals.ps paper was removed for a reason, so I'd advise
you not to print it.

And that reason would be??? Seriously, it seems like a useful paper;
even if it isn't needed in the distribution, it may be worth printing.

Peter E>It doesn't correspond to reality any longer.

Bruce M>I just bloated the tarball and wasn't really for general consuption.

It sounds like the paper should probably be left out of the next set of
PostgreSQL volumes. Perhaps it could go into a volume of "historic" papers.

-r
--
email: rdm@cfcl.com; phone: +1 650-873-7841
http://www.cfcl.com/rdm - my home page, resume, etc.
http://www.cfcl.com/Meta - The FreeBSD Browser, Meta Project, etc.
http://www.ptf.com/dossier - Prime Time Freeware's DOSSIER series
http://www.ptf.com/tdc - Prime Time Freeware's Darwin Collection

#10Bruce Momjian
bruce@momjian.us
In reply to: Rich Morin (#9)

Rich Morin wrote:

At 2:40 PM -0500 3/1/02, Bruce Momjian wrote:

Rich Morin wrote:

At 7:23 PM -0500 2/26/02, Peter Eisentraut wrote:

Well, the internals.ps paper was removed for a reason, so I'd advise
you not to print it.

And that reason would be??? Seriously, it seems like a useful paper;
even if it isn't needed in the distribution, it may be worth printing.

Peter E>It doesn't correspond to reality any longer.

Bruce M>I just bloated the tarball and wasn't really for general consuption.

It sounds like the paper should probably be left out of the next set of
PostgreSQL volumes. Perhaps it could go into a volume of "historic" papers.

There used to be a whole lot of papers at Berkeley web site.

-- 
  Bruce Momjian                        |  http://candle.pha.pa.us
  pgman@candle.pha.pa.us               |  (610) 853-3000
  +  If your life is a hard drive,     |  830 Blythe Avenue
  +  Christ can be your backup.        |  Drexel Hill, Pennsylvania 19026
#11Tom Lane
tgl@sss.pgh.pa.us
In reply to: Bruce Momjian (#10)

Bruce Momjian <pgman@candle.pha.pa.us> writes:

There used to be a whole lot of papers at Berkeley web site.

Still are.

http://s2k-ftp.CS.Berkeley.EDU:8000/postgres/papers/

regards, tom lane

#12Bruce Momjian
bruce@momjian.us
In reply to: Tom Lane (#11)

Tom Lane wrote:

Bruce Momjian <pgman@candle.pha.pa.us> writes:

There used to be a whole lot of papers at Berkeley web site.

Still are.

http://s2k-ftp.CS.Berkeley.EDU:8000/postgres/papers/

Yes, site was down for a while in the past; wasn't sure if it was back
up.

-- 
  Bruce Momjian                        |  http://candle.pha.pa.us
  pgman@candle.pha.pa.us               |  (610) 853-3000
  +  If your life is a hard drive,     |  830 Blythe Avenue
  +  Christ can be your backup.        |  Drexel Hill, Pennsylvania 19026
#13Rich Morin
rdm@cfcl.com
In reply to: Bruce Momjian (#12)

Tom Lane wrote:

Bruce Momjian <pgman@candle.pha.pa.us> writes:

There used to be a whole lot of papers at Berkeley web site.

Still are.

http://s2k-ftp.CS.Berkeley.EDU:8000/postgres/papers/

There is obviously no shortage of historic papers! Would anyone here
like to see me publish one or more volumes of these papers? I can
handle the production details, but I need a wish list of papers to
include and some help in contacting the owners of the articles.

Although USENIX is a conspicuous exception, many organizations and
institutions retain the rights to all material they publish. Thus, it
is not necessarily the case that the author(s) can give permission for
a piece to be included in an anthology. OTOH, if the author _wants_
the piece to be included, we have a fighting chance.

-r
--
email: rdm@cfcl.com; phone: +1 650-873-7841
http://www.cfcl.com/rdm - my home page, resume, etc.
http://www.cfcl.com/Meta - The FreeBSD Browser, Meta Project, etc.
http://www.ptf.com/dossier - Prime Time Freeware's DOSSIER series
http://www.ptf.com/tdc - Prime Time Freeware's Darwin Collection