pg.ddx.io pgsql-docs@postgresql.org mailing list archive
help / color / mirror / Atom feed<application> vs <command>
7+ messages / 3 participants
[nested] [flat]
* <application> vs <command>
@ 2001-11-29 20:13 Bruce Momjian <pgman@candle.pha.pa.us>
0 siblings, 2 replies; 7+ messages in thread
From: Bruce Momjian @ 2001-11-29 20:13 UTC (permalink / raw)
To: pgsql-docs
Can someone clarify when we should use <command> and when we should use
<application>? I see postmaster used with application, but psql and
createdb used with command. Is this correct?
--
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
^ permalink raw reply [nested|flat] 7+ messages in thread
* Re: <application> vs <command>
@ 2001-11-29 20:42 Tom Lane <tgl@sss.pgh.pa.us>
parent: Bruce Momjian <pgman@candle.pha.pa.us>
1 sibling, 1 reply; 7+ messages in thread
From: Tom Lane @ 2001-11-29 20:42 UTC (permalink / raw)
To: Bruce Momjian <pgman@candle.pha.pa.us>; +Cc: pgsql-docs
Bruce Momjian <pgman@candle.pha.pa.us> writes:
> Can someone clarify when we should use <command> and when we should use
> <application>?
More generally, what are the standard set of markup tags that should be
used? I know that I tend to overuse <literal>foo</> because I'm not
clear on the alternatives like <type>, <envar>, <option>, yadda yadda.
It'd help if there were a list somewhere.
regards, tom lane
^ permalink raw reply [nested|flat] 7+ messages in thread
* Re: <application> vs <command>
@ 2001-11-30 18:12 Bruce Momjian <pgman@candle.pha.pa.us>
parent: Peter Eisentraut <peter_e@gmx.net>
2 siblings, 0 replies; 7+ messages in thread
From: Bruce Momjian @ 2001-11-30 18:12 UTC (permalink / raw)
To: Peter Eisentraut <peter_e@gmx.net>; +Cc: pgsql-docs
> Bruce Momjian writes:
>
> > Can someone clarify when we should use <command> and when we should use
> > <application>? I see postmaster used with application, but psql and
> > createdb used with command. Is this correct?
>
> >From "DocBook: The Definitive Guide":
>
> | Command -- The name of an executable program or other software command
> |
> | This element holds the name of an executable program or the text of a
> | command that a user enters to execute a program.
>
> | Application -- The name of a software program
> |
> | The appelation "application" is usually reserved for larger software
> | packages--WordPerfect, for example, but not grep. In some domains,
> | Application may also apply to a piece of hardware.
>
> One could think of psql as a separate "application", but postmaster is
> certainly a command only.
>
> I'm not sure why, given the definition, <command> is put out in bold.
> Monospaced would make more sense to me. <application> could be a remote
> candidate for bold.
Actually, postmaster seems bigger to me that psql. Are the outputs for
the two tags output differently? If so, we better use them
consistently.
--
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
^ permalink raw reply [nested|flat] 7+ messages in thread
* Re: <application> vs <command>
@ 2001-11-30 18:13 Peter Eisentraut <peter_e@gmx.net>
parent: Bruce Momjian <pgman@candle.pha.pa.us>
1 sibling, 3 replies; 7+ messages in thread
From: Peter Eisentraut @ 2001-11-30 18:13 UTC (permalink / raw)
To: Bruce Momjian <pgman@candle.pha.pa.us>; +Cc: pgsql-docs
Bruce Momjian writes:
> Can someone clarify when we should use <command> and when we should use
> <application>? I see postmaster used with application, but psql and
> createdb used with command. Is this correct?
^ permalink raw reply [nested|flat] 7+ messages in thread
* Re: <application> vs <command>
@ 2001-12-01 14:03 Peter Eisentraut <peter_e@gmx.net>
parent: Tom Lane <tgl@sss.pgh.pa.us>
0 siblings, 0 replies; 7+ messages in thread
From: Peter Eisentraut @ 2001-12-01 14:03 UTC (permalink / raw)
To: Tom Lane <tgl@sss.pgh.pa.us>; +Cc: Bruce Momjian <pgman@candle.pha.pa.us>; pgsql-docs
Tom Lane writes:
> More generally, what are the standard set of markup tags that should be
> used? I know that I tend to overuse <literal>foo</> because I'm not
> clear on the alternatives like <type>, <envar>, <option>, yadda yadda.
> It'd help if there were a list somewhere.
At docbook.org you can download (read online, buy, ...) "DocBook: The
Definitive Guide", which contains introductions to SGML, XML, DocBook,
stylesheets, plus a complete reference of all elements, what they're for
and what can go where. I use it nearly every day.
As for what tags to use, it's difficult to keep track of the over a
hundred elements that DocBook has, but "when in doubt, use <literal>"
seems like a reasonable thing to do and it seems to fit the idea of the
element.
One day we might want to add some tags that fit our domain better, such as
<sqlcode> or <databaseobject>.
--
Peter Eisentraut peter_e@gmx.net
^ permalink raw reply [nested|flat] 7+ messages in thread
* Re: <application> vs <command>
@ 2001-12-05 23:09 Bruce Momjian <pgman@candle.pha.pa.us>
parent: Peter Eisentraut <peter_e@gmx.net>
2 siblings, 0 replies; 7+ messages in thread
From: Bruce Momjian @ 2001-12-05 23:09 UTC (permalink / raw)
To: Peter Eisentraut <peter_e@gmx.net>; +Cc: pgsql-docs
> Bruce Momjian writes:
>
> > Can someone clarify when we should use <command> and when we should use
> > <application>? I see postmaster used with application, but psql and
> > createdb used with command. Is this correct?
>
> >From "DocBook: The Definitive Guide":
>
> | Command -- The name of an executable program or other software command
> |
> | This element holds the name of an executable program or the text of a
> | command that a user enters to execute a program.
>
> | Application -- The name of a software program
> |
> | The appelation "application" is usually reserved for larger software
> | packages--WordPerfect, for example, but not grep. In some domains,
> | Application may also apply to a piece of hardware.
>
> One could think of psql as a separate "application", but postmaster is
> certainly a command only.
>
> I'm not sure why, given the definition, <command> is put out in bold.
> Monospaced would make more sense to me. <application> could be a remote
> candidate for bold.
I see both <command> and <application> SGML tags is used for the
following items in our current CVS:
createdb
cvs checkout
ecpg
gcc
gzip
initdb
pg_dumpall
pgtclsh
postmaster
ps
psql
sed
ssh
strace
sysctl
tcsh
--
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
^ permalink raw reply [nested|flat] 7+ messages in thread
* Re: <application> vs <command>
@ 2001-12-27 04:48 Bruce Momjian <pgman@candle.pha.pa.us>
parent: Peter Eisentraut <peter_e@gmx.net>
2 siblings, 0 replies; 7+ messages in thread
From: Bruce Momjian @ 2001-12-27 04:48 UTC (permalink / raw)
To: Peter Eisentraut <peter_e@gmx.net>; +Cc: pgsql-docs
OK, Peter, can I clean these up? Seems like a quiet time to do that.
Are applications things you interact with, like psql, while commands are
things like grep and createdb?
In reading the definition below, I thought PostgreSQL was an
application, while psql and postmaster were both commands. You type
psql and postmaster, but not PostgreSQL. That would fit with the
WordPerfect comment.
---------------------------------------------------------------------------
> Bruce Momjian writes:
>
> > Can someone clarify when we should use <command> and when we should use
> > <application>? I see postmaster used with application, but psql and
> > createdb used with command. Is this correct?
>
> >From "DocBook: The Definitive Guide":
>
> | Command -- The name of an executable program or other software command
> |
> | This element holds the name of an executable program or the text of a
> | command that a user enters to execute a program.
>
> | Application -- The name of a software program
> |
> | The appelation "application" is usually reserved for larger software
> | packages--WordPerfect, for example, but not grep. In some domains,
> | Application may also apply to a piece of hardware.
>
> One could think of psql as a separate "application", but postmaster is
> certainly a command only.
>
> I'm not sure why, given the definition, <command> is put out in bold.
> Monospaced would make more sense to me. <application> could be a remote
> candidate for bold.
>
> --
> Peter Eisentraut peter_e@gmx.net
>
>
--
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
^ permalink raw reply [nested|flat] 7+ messages in thread
end of thread, other threads:[~2001-12-27 04:48 UTC | newest]
Thread overview: 7+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2001-11-29 20:13 <application> vs <command> Bruce Momjian <pgman@candle.pha.pa.us>
2001-11-29 20:42 ` Tom Lane <tgl@sss.pgh.pa.us>
2001-12-01 14:03 ` Peter Eisentraut <peter_e@gmx.net>
2001-11-30 18:13 ` Peter Eisentraut <peter_e@gmx.net>
2001-11-30 18:12 ` Bruce Momjian <pgman@candle.pha.pa.us>
2001-12-05 23:09 ` Bruce Momjian <pgman@candle.pha.pa.us>
2001-12-27 04:48 ` Bruce Momjian <pgman@candle.pha.pa.us>
This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox