Home > mailing lists

Thread: pgadmin3 manpage

pgadmin3 manpage

From

Raphaël Enrici

Date:

10 February 2004, 20:26:25

Let's go on :)

Attached is a proposal for the pgadmin3 manpage I wish to include in
debian package.

Comments/corrections are welcome.

Regards,
Raphaël

.\" Hey, EMACS: -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh disable hyphenation
.\" .hy enable hyphenation
.\" .ad l left justify
.\" .ad b justify to both left and right margins
.\" .nf disable filling
.\" .fi enable filling
.\" .br insert line break
.\" .sp <n> insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.TH "PGADMIN3" "1" "February 9, 2004" "" ""
.SH "NAME"
pgadmin3 \- PostgreSQL Tools
.SH "SYNOPSIS"
.B pgadmin3
.RI
.br

.SH "DESCRIPTION"
.LP
\fBpgadmin3\fP is a database design and management application for use with PostgreSQL.
.br
.LP
It includes a graphical administration interface, an SQL query tool, a procedural code editor and much more.
.br
pgAdmin III is designed to answer the needs of all
users, from writing simple SQL queries to developing complex databases.
Available in more than 30 languages and for several operating systems.
.br
Please visit http://www.pgadmin.org/ for more details.

This manual page was written for the Debian distribution
because the original program does not have a manual page.

.SH "OPTIONS"
This program is a graphical application. Simply type \fBpgadmin3\fR on a command line to launch the GUI. There is no
optionsat all for it.
.SH "SEE ALSO"
.BR psql (1),
.SH "AUTHOR"
This manual page was written by Raphael Enrici <pgadmin\-hackers@postgresql.org>,
for the Debian project (but may be used by others).

Re: pgadmin3 manpage

From

"Dave Page"

Date:

10 February 2004, 21:22:02


> -----Original Message-----
> From: Raphaël Enrici [mailto:blacknoz@club-internet.fr]
> Sent: 10 February 2004 21:26
> To: pgadmin-hackers@postgresql.org
> Subject: [pgadmin-hackers] pgadmin3 manpage
>
> Let's go on :)
>
> Attached is a proposal for the pgadmin3 manpage I wish to
> include in debian package.
>
> Comments/corrections are welcome.

There is no options

Should be

There are no options

:-)

Regards, Dave.

Re: pgadmin3 manpage

From

Andreas Pflug

Date:

11 February 2004, 09:55:03

Raphaël Enrici wrote:

> Let's go on :)
>
> Attached is a proposal for the pgadmin3 manpage I wish to include in
> debian package.
>
> Comments/corrections are welcome.
>
> Regards,
> Raphaël
>
>------------------------------------------------------------------------
>
>.\" Hey, EMACS: -*- nroff -*-
>.\" First parameter, NAME, should be all caps
>.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
>.\" other parameters are allowed: see man(7), man(1)
>.\" Please adjust this date whenever revising the manpage.
>.\"
>.\" Some roff macros, for reference:
>.\" .nh        disable hyphenation
>.\" .hy        enable hyphenation
>.\" .ad l      left justify
>.\" .ad b      justify to both left and right margins
>.\" .nf        disable filling
>.\" .fi        enable filling
>.\" .br        insert line break
>.\" .sp <n>    insert n+1 empty lines
>.\" for manpage-specific macros, see man(7)
>.TH "PGADMIN3" "1" "February  9, 2004" "" ""
>.SH "NAME"
>pgadmin3 \- PostgreSQL Tools
>.SH "SYNOPSIS"
>.B pgadmin3
>.RI
>.br
>
>.SH "DESCRIPTION"
>.LP
>\fBpgadmin3\fP is a database design and management application for use with PostgreSQL.
>.br
>.LP
>It includes a graphical administration interface, an SQL query tool, a procedural code editor and much more.
>.br
>pgAdmin III is designed to answer the needs of all
>users, from writing simple SQL queries to developing complex databases.
>Available in more than 30 languages and for several operating systems.
>.br
>Please visit http://www.pgadmin.org/ for more details.
>
>This manual page was written for the Debian distribution
>because the original program does not have a manual page.
>
>
>.SH "OPTIONS"
>This program is a graphical application. Simply type \fBpgadmin3\fR on a command line to launch the GUI. There is no
optionsat all for it. 
>.SH "SEE ALSO"
>.BR psql (1),
>.SH "AUTHOR"
>This manual page was written by Raphael Enrici <pgadmin\-hackers@postgresql.org>,
>for the Debian project (but may be used by others).
>
>

Maybe some hint that there's online documentation available as soon as
pgadmin3 is launched?

Regards,
Andreas

Re: pgadmin3 manpage

From

Raphaël Enrici

Date:

11 February 2004, 17:28:01

Andreas Pflug wrote:

>
>
> Maybe some hint that there's online documentation available as soon as
> pgadmin3 is launched?

Dave, I fixed the typo (thanks!). I also fixed "all users" with "most
users".
Andreas, I added a word on this.
It something like that: "NOTE: You may find useful informations in the
help menu of pgAdmin3."

File attached. May be this would be a good thing to add a man page to
cvs too.

You didn't tell me what you thought about package description. Did you
receive these mails ? Shall I understand it's alright with you ?

I'm gonna submit the package to my debian sponsor tonight. I hope to get
news soon.

Regards,
Raphaël

.SH "DESCRIPTION"
.LP
\fBpgadmin3\fP is a database design and management application for use with PostgreSQL.
.br
.LP
It includes a graphical administration interface, an SQL query tool, a procedural code editor and much more.
.br
pgAdmin III is designed to answer the needs of most
users, from writing simple SQL queries to developing complex databases.
Available in more than 30 languages and for several operating systems.
.br
\fBNOTE:\fP You may find useful informations in the help menu of pgAdmin3.
.br
Please visit http://www.pgadmin.org/ for more details.

This manual page was written for the Debian distribution
because the original program does not have a manual page.

.SH "OPTIONS"
This program is a graphical application. Simply type \fBpgadmin3\fR on a command line to launch the GUI. There are no
optionsat all for it.
.SH "SEE ALSO"
.BR psql (1),
.SH "AUTHOR"
This manual page was written by Raphael Enrici <pgadmin\-hackers@postgresql.org>,
for the Debian project (but may be used by others).

Re: pgadmin3 manpage

From

"Dave Page"

Date:

11 February 2004, 21:11:21


> -----Original Message-----
> From: Raphaël Enrici [mailto:blacknoz@club-internet.fr]
> Sent: 11 February 2004 18:26
> To: Andreas Pflug; Dave Page
> Cc: pgadmin-hackers@postgresql.org
> Subject: Re: [pgadmin-hackers] pgadmin3 manpage
>
> You didn't tell me what you thought about package
> description. Did you receive these mails ? Shall I understand
> it's alright with you ?

Sorry, *really* busy at the moment. The description (the one in the man page?) looks great, but Jean-Michel has been
workingon the new description for his PAD file as well. Perhaps we should use just one for consistency? 

Regards, Dave.

Re: pgadmin3 manpage

From

blacknoz@club-internet.fr

Date:

12 February 2004, 07:13:52



----Message d'origine----
>Date: Wed, 11 Feb 2004 22:11:00 -0000
>De: "Dave Page" <dpage@vale-housing.co.uk>
>A: Raphaël Enrici <blacknoz@club-internet.fr>,
>Copie à: <pgadmin-hackers@postgresql.org>
>Sujet: Re: [pgadmin-hackers] pgadmin3 manpage
>

>
>Sorry, *really* busy at the moment.

I can understand that. I didn't want to insist. Hope I didn't hurt you. :)

> The description (the one in the man page?) looks great, but >Jean-Michel has been working on the new description for
hisPAD file as well. Perhaps we should use just one for consistency? 
>

I largely inspired from JM's description.
I would suggest we include a kind of manpage upstream rather than specifically in debian. By doing this we can imagine
wewould be able to produce localised manpages too (that could be part of the translator registration process). 

Regards,
Raphaël

Re: pgadmin3 manpage

From

"Dave Page"

Date:

12 February 2004, 07:30:10


> -----Original Message-----
> From: blacknoz@club-internet.fr [mailto:blacknoz@club-internet.fr]
> Sent: 12 February 2004 09:14
> To: Dave Page; pgadmin@pse-consulting.de; jm@poure.com
> Cc: pgadmin-hackers@postgresql.org
> Subject: Re: Re: [pgadmin-hackers] pgadmin3 manpage
>
>
> >
> >Sorry, *really* busy at the moment.
>
> I can understand that. I didn't want to insist. Hope I didn't
> hurt you. :)

No problem - just juggling a very pregnant wife, a tricky module at Uni,
writing a dissertation proposal, fixing a resource hungry search engine,
and tweaking the view data filtering for Matt Doggett :-) Oh, and for
some reason my boss expects me to work 8 hours a day as well!

>
> I largely inspired from JM's description.
> I would suggest we include a kind of manpage upstream rather
> than specifically in debian. By doing this we can imagine we
> would be able to produce localised manpages too (that could
> be part of the translator registration process).

I agree that we should include a standard manpage rather than a distro
specific one. It won't hurt on any *nix.

As for the specific text, please liase with Jean-Michel and agree
something standard. I'm not overly fussed what it says as I know you can
all come up with something appropriate, but I'd rather not have lot's of
different versions :-)

Cheers, Dave.