Debian Bug report logs - #178583
wwwconfig-common: No documentation available

Reply or subscribe to this bug.

Display info messages

Message #5 received at [email protected] (full text, mbox, reply):

From: Andreas Tille <[email protected]>

To: Debian Bug Tracking System <[email protected]>

Subject: wwwconfig-common: No documentation available

Date: Mon, 27 Jan 2003 11:07:15 +0100

Package: wwwconfig-common
Version: 0.0.24
Severity: wishlist

Hello,

I have seen that some packages which contain PHP scripts use
this package in their postinst scripts.  I would like to do
this as well because i guess it is a clever idea.  Unfortunately
the package is quite undocumented and I'm not able to get a clue
how to use the scripts right.

Kind regards and thanks for maintaining this package

          Andreas.

-- System Information
Debian Release: testing/unstable
Architecture: i386
Kernel: Linux wr-linux04 2.4.20 #1 Fre Jan 10 14:27:35 CET 2003 i686
Locale: LANG=de_DE@euro, LC_CTYPE=de_DE@euro

Message #10 received at [email protected] (full text, mbox, reply):

From: Ola Lundqvist <[email protected]>

To: Andreas Tille <[email protected]>, [email protected]

Subject: Re: Bug#178583: wwwconfig-common: No documentation available

Date: Tue, 28 Jan 2003 17:30:47 +0100

Hi

On Mon, Jan 27, 2003 at 11:07:15AM +0100, Andreas Tille wrote:
> Package: wwwconfig-common
> Version: 0.0.24
> Severity: wishlist
> 
> Hello,
> 
> I have seen that some packages which contain PHP scripts use
> this package in their postinst scripts.  I would like to do
> this as well because i guess it is a clever idea.  Unfortunately
> the package is quite undocumented and I'm not able to get a clue
> how to use the scripts right.

Yes I'd love some documentation.

The script contain most you will need though.

you set a bunch of variables (documented in the scripts)
and then you source the script.

. /usr/.../wwwconfig-common/foobar.foo

It then performes some things and maybe changes some
variables. Also documented.

I would like to extend this to configure other things than
just www apps and in the same time make better documentation.

Patches, suggestions (etc) is very welcome. And of course
documentation. :)

> Kind regards and thanks for maintaining this package

Thanks for the appriciation.

Regards,

// Ola

>           Andreas.
> 
> -- System Information
> Debian Release: testing/unstable
> Architecture: i386
> Kernel: Linux wr-linux04 2.4.20 #1 Fre Jan 10 14:27:35 CET 2003 i686
> Locale: LANG=de_DE@euro, LC_CTYPE=de_DE@euro
> 
> 

-- 
 --------------------- Ola Lundqvist ---------------------------
/  [email protected]                     Annebergsslingan 37      \
|  [email protected]                 654 65 KARLSTAD          |
|  +46 (0)54-10 14 30                  +46 (0)70-332 1551       |
|  http://www.opal.dhs.org             UIN/icq: 4912500         |
\  gpg/f.p.: 7090 A92B 18FE 7994 0C36  4FE4 18A1 B1CF 0FE5 3DD9 /
 ---------------------------------------------------------------

Message #15 received at [email protected] (full text, mbox, reply):

From: Andreas Tille <[email protected]>

Cc: [email protected]

Subject: Re: Bug#178583: wwwconfig-common: No documentation available

Date: Wed, 29 Jan 2003 08:04:34 +0100 (CET)

On Tue, 28 Jan 2003, Ola Lundqvist wrote:

> Yes I'd love some documentation.
>
> The script contain most you will need though.
I've seen the documentation inside the scripts.  It helps a little but
what I'm missing is a document providing a general overview when and
how to use these scripts.

> you set a bunch of variables (documented in the scripts)
Sorry for my ignorance.  I observed that the scripts need several
variables but I'm missing some guideline for reasonable values - at
least in those scripts I looked into.

> and then you source the script.
>
> . /usr/.../wwwconfig-common/foobar.foo
>
> It then performes some things and maybe changes some
> variables. Also documented.
>
> I would like to extend this to configure other things than
> just www apps and in the same time make better documentation.
May be we could cope the idea from the posting

  http://lists.debian.org/debian-devel/2003/debian-devel-200301/msg01164.html

After I detected wwwconfig-common I felt that some parts of this posting
are realized in scripts - but than I had to file this bug report to
accomplish the main part of the posting. ;-)

> Patches, suggestions (etc) is very welcome. And of course
> documentation. :)
I'll try to do my part once I managed to use some stuff from the package
successfully.

Kind regards

        Andreas.

Message #20 received at [email protected] (full text, mbox, reply):

From: Ola Lundqvist <[email protected]>

To: Andreas Tille <[email protected]>, [email protected]

Subject: Re: Bug#178583: wwwconfig-common: No documentation available

Date: Wed, 29 Jan 2003 08:45:45 +0100

Hi

On Wed, Jan 29, 2003 at 08:04:34AM +0100, Andreas Tille wrote:
> On Tue, 28 Jan 2003, Ola Lundqvist wrote:
> 
> > Yes I'd love some documentation.
> >
> > The script contain most you will need though.
> I've seen the documentation inside the scripts.  It helps a little but
> what I'm missing is a document providing a general overview when and
> how to use these scripts.
> 
> > you set a bunch of variables (documented in the scripts)
> Sorry for my ignorance.  I observed that the scripts need several
> variables but I'm missing some guideline for reasonable values - at
> least in those scripts I looked into.

Ohh sorry. Well reasonable values... Hmm ... yes that might not always
be easy to tell.

> > and then you source the script.
> >
> > . /usr/.../wwwconfig-common/foobar.foo
> >
> > It then performes some things and maybe changes some
> > variables. Also documented.
> >
> > I would like to extend this to configure other things than
> > just www apps and in the same time make better documentation.
> May be we could cope the idea from the posting
> 
>   http://lists.debian.org/debian-devel/2003/debian-devel-200301/msg01164.html

Actually I had read that, but not the follow-ups. :)

> After I detected wwwconfig-common I felt that some parts of this posting
> are realized in scripts - but than I had to file this bug report to
> accomplish the main part of the posting. ;-)

Hehe. Yes such a bug is reasonable. I think lot of the documentation
you are requesting should be placed in DDP, as Joey says. But wwwconfig-common
should really be better documented.

> > Patches, suggestions (etc) is very welcome. And of course
> > documentation. :)
> I'll try to do my part once I managed to use some stuff from the package
> successfully.

That would be great.

Sometime when I get some more time I'll finish the dconfigure package
(or with an other name).

An idea that just popped up in my head is some new debhelper
scripts that creates debconf questions and do things in postinst.
Maybe something to work for. But not today.

Regards,

// Ola

> Kind regards
> 
>         Andreas.
> 
> 

-- 
 --------------------- Ola Lundqvist ---------------------------
/  [email protected]                     Annebergsslingan 37      \
|  [email protected]                 654 65 KARLSTAD          |
|  +46 (0)54-10 14 30                  +46 (0)70-332 1551       |
|  http://www.opal.dhs.org             UIN/icq: 4912500         |
\  gpg/f.p.: 7090 A92B 18FE 7994 0C36  4FE4 18A1 B1CF 0FE5 3DD9 /
 ---------------------------------------------------------------

Message #25 received at [email protected] (full text, mbox, reply):

From: Matthew Palmer <[email protected]>

To: [email protected]

Subject: Documentation (partial) written

Date: Tue, 22 Jul 2003 11:43:07 +1000

[Message part 1 (text/plain, inline)]

I've written an overview manpage for wwwconfig-common, along with the
necessary rules info to include it in the built package.  I've included the
complete patch, relative to 0.0.27.

In future, any manpages which are written for specific commands (and I think
that most, if not all of them, need one, as well as an expansion of the best
usage of the package as a whole), merely need to be put in the manpages
directory, and everything will be taken care of automagically.

- Matt

[docpatch (text/plain, attachment)]

Message #30 received at [email protected] (full text, mbox, reply):

From: Ola Lundqvist <[email protected]>

To: Matthew Palmer <[email protected]>, [email protected]

Subject: Re: Bug#178583: Documentation (partial) written

Date: Tue, 22 Jul 2003 09:57:37 +0200

Hello

This is really great!

On Tue, Jul 22, 2003 at 11:43:07AM +1000, Matthew Palmer wrote:
> I've written an overview manpage for wwwconfig-common, along with the
> necessary rules info to include it in the built package.  I've included the
> complete patch, relative to 0.0.27.
> 
> In future, any manpages which are written for specific commands (and I think
> that most, if not all of them, need one, as well as an expansion of the best
> usage of the package as a whole), merely need to be put in the manpages
> directory, and everything will be taken care of automagically.

Did you write the manpage from scratch or did you use a tool to create it?

I'm not very good at raw manpage format. :)

I'll add this but modify the build things slightly.

I also think about making wwwconfig-common more general in that you can
configure more things than web-related things. What do you think about
such an idea?

Regards,

// Ola

> - Matt

> diff -uNr wwwconfig-common-0.0.27/debian/rules wwwconfig-common-0.0.27.mpalmer/debian/rules
> --- wwwconfig-common-0.0.27/debian/rules	Thu Aug 23 20:19:16 2001
> +++ wwwconfig-common-0.0.27.mpalmer/debian/rules	Tue Jul 22 11:32:22 2003
> @@ -8,6 +8,8 @@
>  # This is the debhelper compatability version to use.
>  export DH_COMPAT=2
>  
> +DESTDIR=$(CURDIR)/debian/wwwconfig-common
> +
>  clean:
>  	dh_testdir
>  	dh_testroot
> @@ -21,10 +23,16 @@
>  	dh_testroot
>  	dh_clean -k
>  	dh_installdirs
> -
> +	
>  	# Add here commands to install the package into debian/wwwconfig-common.
> -	cp *.func *.get *.sh $(CURDIR)/debian/wwwconfig-common/usr/share/wwwconfig-common
> -	rm -f $(CURDIR)/debian/wwwconfig-common/usr/share/wwwconfig-common/test.sh
> +	cp *.func *.get *.sh $(DESTDIR)/usr/share/wwwconfig-common
> +	rm -f $(DESTDIR)/usr/share/wwwconfig-common/test.sh
> +
> +	# Manpage version translation
> +	ver=`dpkg-parsechangelog | grep Version: | sed 's/^Version: //'`; \
> +	for i in manpages/*; do \
> +		sed "s/##PKG_VERSION##/$$ver/" $$i > $(DESTDIR)/usr/share/man/`basename $$i`; \
> +	done
>  
>  # Build architecture-independent files here.
>  binary-indep: install
> @@ -32,6 +40,8 @@
>  	dh_testroot
>  #	dh_installdebconf
>  	dh_installdocs
> +	dh_installman $(DESTDIR)/usr/share/man/*
> +	rm -f $(DESTDIR)/usr/share/man/*.[17]
>  #	dh_undocumented
>  	dh_installchangelogs 
>  	dh_link
> diff -uNr wwwconfig-common-0.0.27/debian/wwwconfig-common.dirs wwwconfig-common-0.0.27.mpalmer/debian/wwwconfig-common.dirs
> --- wwwconfig-common-0.0.27/debian/wwwconfig-common.dirs	Sun Feb 16 03:23:52 2003
> +++ wwwconfig-common-0.0.27.mpalmer/debian/wwwconfig-common.dirs	Tue Jul 22 11:19:39 2003
> @@ -1 +1,2 @@
>  usr/share/wwwconfig-common
> +usr/share/man
> diff -uNr wwwconfig-common-0.0.27/manpages/wwwconfig-common.7 wwwconfig-common-0.0.27.mpalmer/manpages/wwwconfig-common.7
> --- wwwconfig-common-0.0.27/manpages/wwwconfig-common.7	Thu Jan  1 10:00:00 1970
> +++ wwwconfig-common-0.0.27.mpalmer/manpages/wwwconfig-common.7	Tue Jul 22 11:26:47 2003
> @@ -0,0 +1,266 @@
> +.de Sh \" Subsection heading
> +.br
> +.if t .Sp
> +.ne 5
> +.PP
> +\fB\\$1\fR
> +.PP
> +..
> +.de Sp \" Vertical space (when we can't use .PP)
> +.if t .sp .5v
> +.if n .sp
> +..
> +.de Vb \" Begin verbatim text
> +.ft CW
> +.nf
> +.ne \\$1
> +..
> +.de Ve \" End verbatim text
> +.ft R
> +.fi
> +..
> +.\" Set up some character translations and predefined strings.  \*(-- will
> +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
> +.\" double quote, and \*(R" will give a right double quote.  | will give a
> +.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
> +.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
> +.\" expand to `' in nroff, nothing in troff, for use with C<>.
> +.tr \(*W-|\(bv\*(Tr
> +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
> +.ie n \{\
> +.    ds -- \(*W-
> +.    ds PI pi
> +.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
> +.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
> +.    ds L" ""
> +.    ds R" ""
> +.    ds C` ""
> +.    ds C' ""
> +'br\}
> +.el\{\
> +.    ds -- \|\(em\|
> +.    ds PI \(*p
> +.    ds L" ``
> +.    ds R" ''
> +'br\}
> +.\"
> +.\" If the F register is turned on, we'll generate index entries on stderr for
> +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
> +.\" entries marked with X<> in POD.  Of course, you'll have to process the
> +.\" output yourself in some meaningful fashion.
> +.if \nF \{\
> +.    de IX
> +.    tm Index:\\$1\t\\n%\t"\\$2"
> +..
> +.    nr % 0
> +.    rr F
> +.\}
> +.\"
> +.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
> +.\" way too many mistakes in technical documents.
> +.hy 0
> +.if n .na
> +.\"
> +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
> +.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
> +.    \" fudge factors for nroff and troff
> +.if n \{\
> +.    ds #H 0
> +.    ds #V .8m
> +.    ds #F .3m
> +.    ds #[ \f1
> +.    ds #] \fP
> +.\}
> +.if t \{\
> +.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
> +.    ds #V .6m
> +.    ds #F 0
> +.    ds #[ \&
> +.    ds #] \&
> +.\}
> +.    \" simple accents for nroff and troff
> +.if n \{\
> +.    ds ' \&
> +.    ds ` \&
> +.    ds ^ \&
> +.    ds , \&
> +.    ds ~ ~
> +.    ds /
> +.\}
> +.if t \{\
> +.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
> +.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
> +.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
> +.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
> +.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
> +.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
> +.\}
> +.    \" troff and (daisy-wheel) nroff accents
> +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
> +.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
> +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
> +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
> +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
> +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
> +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
> +.ds ae a\h'-(\w'a'u*4/10)'e
> +.ds Ae A\h'-(\w'A'u*4/10)'E
> +.    \" corrections for vroff
> +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
> +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
> +.    \" for low resolution devices (crt and lpr)
> +.if \n(.H>23 .if \n(.V>19 \
> +\{\
> +.    ds : e
> +.    ds 8 ss
> +.    ds o a
> +.    ds d- d\h'-1'\(ga
> +.    ds D- D\h'-1'\(hy
> +.    ds th \o'bp'
> +.    ds Th \o'LP'
> +.    ds ae ae
> +.    ds Ae AE
> +.\}
> +.rm #[ #] #H #V #F C
> +.\" ========================================================================
> +.\"
> +.IX Title "WWWCONFIG-COMMON 7"
> +.TH WWWCONFIG-COMMON 7 "2003-07-22" "##PKG_VERSION##" "wwwconfig-common"
> +.SH "NAME"
> +wwwconfig-common \- the wwwconfig-common tool suite
> +.SH "SYNOPSIS"
> +.IX Header "SYNOPSIS"
> +\&\fB/usr/share/wwwconfig-common/*\fR
> +.SH "DESCRIPTION"
> +.IX Header "DESCRIPTION"
> +Wwwconfig-common is intended to help you configure a package which provides
> +web services of some kind, manipulating apache config files and databases to
> +achieve the desired effect.
> +.PP
> +The philosophy behind wwwconfig-common is to provide a collection of small,
> +simple, and easily understood tools that are used in package maintainer
> +scripts (most likely in concert with debconf) to automate various common
> +aspects of configuring a web services package. This means less work for you,
> +the packager. It also, to some degree means that these tools can be changed
> +if the configuration of web servers and database engines change, meaning
> +less effort needs to go into fixing the packages that use them.
> +.PP
> +A typical package that uses wwwconfig-common will call several
> +wwwconfig-common commands in sequence. The wwwconfig-common commands are all
> +located in \*(L"/usr/share/wwwconfig-common\*(R".
> +
> +.SH "WWWCONFIG-COMMON COMMANDS"
> +.IX Header "WWWCONFIG-COMMON COMMANDS"
> +
> +Here is a (hopefully) complete list of available wwwconfig-common commands.
> +See their man pages for additional documentation (if available), or the
> +source code for additional comments on their usage.  An indication of
> +whether the command has a manpage is a number in brackets after it (but
> +don't take that as gospel).
> +.Sp
> +.RS 4
> +.IP apache-addtype_all.sh
> +add an AddType directive to an apache config.
> +.IP apache-cominclude.sh
> +comment out an Include directive in a config file.
> +.IP apache-cominclude_all.sh
> +comment out an Include directive in all the config files for a webserver.
> +.IP apache-include-postrm.sh
> +do the Right Thing for Include directives in an apache config, based on the
> +arguments to the postrm script.
> +.IP apache-include.sh
> +Include a file in an apache config file, possibly uncommenting an existing
> +Include directive.
> +.IP apache-include_all.sh
> +as per apache-include.sh, but checks all the config files of the webserver
> +for the appropriate Include directive.
> +.IP apache-index.sh
> +adds a filename which is to be considered as an index file (a DirectoryIndex
> +directive).
> +.IP apache-index_all.sh
> +as per apache-index.sh, but checks all the config files of the webserver for
> +an existing appropriate DirectoryIndex directive.
> +.IP apache-php.sh
> +verify that PHP is installed in the webserver.
> +.IP apache-uncominclude.sh
> +uncomment an apache Include directive.
> +.IP apache-uninclude.sh
> +remove the Include directive for a given file.
> +.IP apache-uninclude_all.sh
> +remove the Include directive for a given file from all the config files for
> +a webserver.
> +.IP autopatch.sh
> +apply a patch.
> +.IP autopatch_all.sh
> +applies all the patches found in a directory.
> +.IP exim-trust.sh
> +tell exim to "trust" a user (allow them to set the Sender: header, amongst
> +other things).
> +.IP mysql-createdb.sh
> +create a DB in a MySQL server.
> +.IP mysql-createuser.sh
> +create a user on a MySQL server.
> +.IP mysql-dropdb.sh
> +remove a database from a MySQL server.
> +.IP mysql-dropuser.sh
> +remove a user from a MySQL server.
> +.IP mysql-exec.sh
> +execute an SQL script on a MySQL server.
> +.IP mysql-if-exec.sh
> +execute an SQL script on a MySQL server if an SQL command runs successfully.
> +.IP mysql-ifnot-exec.sh
> +execute an SQL script on a MySQL server if an SQL command fails.
> +.IP pgsql-allowip.sh
> +allow IP connections to the PgSQL database.
> +.IP pgsql-createdb.sh
> +create a DB in a PostgreSQL server.
> +.IP pgsql-createuser.sh
> +create a user on a PostgreSQL server.
> +.IP pgsql-dropdb.sh
> +remove a database from a PostgreSQL server.
> +.IP pgsql-dropuser.sh
> +remove a user from a PostgreSQL server.
> +.IP pgsql-exec.sh
> +execute an SQL script on a PostgreSQL server.
> +.IP pgsql-if-exec.sh
> +execute an SQL script on a PostgreSQL server if an SQL command runs
> +successfully.
> +.IP pgsql-ifnot-exec.sh
> +execute an SQL script on a PostgreSQL server if an SQL command fails.
> +.IP php-extensions.sh
> +verify that a needed extension is loaded in the PHP config.
> +.IP restart.sh
> +Automatically restart apache servers if they need it (after a config
> +update).
> +
> +.SH "NOTES"
> +.IX Header "NOTES"
> +.Sh "Calling conventions"
> +.IX Subsection "Calling conventions"
> +All of the scripts in wwwconfig-common take their information the same way,
> +as environment variables.  Before calling any script, you should set the
> +appropriate variables in the usual way.  If you're using Perl in your
> +maintainer scripts, you should set the variables on the command line prior
> +to calling the script, such as \fBservers=apache restart.sh\fR.
> +
> +.Sh "Dependant packages"
> +.IX Subsection "Dependant packages"
> +There is a large number of scripts in wwwconfig-common, and it is unlikely
> +that any one package will use all of them (or even a large subset of them).
> +Therefore, in order to keep dependency bloat to a minimum, any package which
> +uses a script that, in turn, needs commands from another package must depend
> +on that package itself.  Do not expect wwwconfig-common to depend on these
> +packages itself.
> +
> +.PP
> +As an example, if I have a package which uses \fBmysql-exec.sh\fR, my
> +package must depend on mysql-client, since \fBmysql-exec.sh\fR uses the
> +\fBmysql\fR command to do it's work.
> +
> +.SH "AUTHOR"
> +.IX Header "AUTHOR"
> +The wwwconfig-common scripts were written by Ola Lundqvist
> +<[email protected]>, with contributions from Luca De Vitis <[email protected]>
> +and Arndt Schönewald.  This manpage was written by Matthew Palmer
> +<[email protected]>, modelled from the debhelper manpage written by Joey
> +Hess.


-- 
 --------------------- Ola Lundqvist ---------------------------
/  [email protected]                     Annebergsslingan 37      \
|  [email protected]                 654 65 KARLSTAD          |
|  +46 (0)54-10 14 30                  +46 (0)70-332 1551       |
|  http://www.opal.dhs.org             UIN/icq: 4912500         |
\  gpg/f.p.: 7090 A92B 18FE 7994 0C36  4FE4 18A1 B1CF 0FE5 3DD9 /
 ---------------------------------------------------------------

Message #35 received at [email protected] (full text, mbox, reply):

From: Ola Lundqvist <[email protected]>

To: Matthew Palmer <[email protected]>

Cc: [email protected]

Subject: Re: Bug#178583: Documentation (partial) written

Date: Tue, 22 Jul 2003 14:21:30 +0200

Hello

On Tue, Jul 22, 2003 at 06:56:32PM +1000, Matthew Palmer wrote:
> On Tue, Jul 22, 2003 at 09:57:37AM +0200, Ola Lundqvist wrote:
> > On Tue, Jul 22, 2003 at 11:43:07AM +1000, Matthew Palmer wrote:
> > > I've written an overview manpage for wwwconfig-common, along with the
> > > necessary rules info to include it in the built package.  I've included the
> > > complete patch, relative to 0.0.27.
> > > 
> > > In future, any manpages which are written for specific commands (and I think
> > > that most, if not all of them, need one, as well as an expansion of the best
> > > usage of the package as a whole), merely need to be put in the manpages
> > > directory, and everything will be taken care of automagically.
> > 
> > Did you write the manpage from scratch or did you use a tool to create it?
> 
> I took the debhelper(7) manpage off my system, and then edited it to fit.

Ok. It might be better to write it in docbook or something that I can
manage without a bigger problem. On the other hand it is a lot better with
a manpage than without one. :) Thanks again.

> > I'm not very good at raw manpage format. :)
> 
> I used to hack raw troff some years back, but haven't in ages (LaTeX is my
> format these days).  I can't remember too much of the stuff, I just took the
> macros that were there already, and duplicated as necessary...

Ok.

> > I'll add this but modify the build things slightly.
> 
> Mmmkay.  As long as I can type 'man wwwconfig-common', I'll be happy.

:)

> I'll probably write specific man pages for the commands I use as I get used
> to using them, I'll submit them as wishlist bugs as I write them.  But I
> think it's important to have an overview page for reference.

That would be really great.

> > I also think about making wwwconfig-common more general in that you can
> > configure more things than web-related things. What do you think about
> > such an idea?
> 
> Hmm, how general were you planning on going?  I think there has to be a
> limit to how broad wwwconfig-common should go, but there is more stuff that
> could go in, I'm sure.

I'm planning on a generic interface for configuring other packages.
Of course it has to be renamed then. wwwconfig-common is basically
just an interface on how to configure exim, mysql, postgres,
php and apache. This should be possible to generalize.

Regards,

// Ola

> - Matt

-- 
 --------------------- Ola Lundqvist ---------------------------
/  [email protected]                     Annebergsslingan 37      \
|  [email protected]                 654 65 KARLSTAD          |
|  +46 (0)54-10 14 30                  +46 (0)70-332 1551       |
|  http://www.opal.dhs.org             UIN/icq: 4912500         |
\  gpg/f.p.: 7090 A92B 18FE 7994 0C36  4FE4 18A1 B1CF 0FE5 3DD9 /
 ---------------------------------------------------------------

Message #40 received at [email protected] (full text, mbox, reply):

From: Ola Lundqvist <[email protected]>

To: Matthew Palmer <[email protected]>

Cc: [email protected]

Subject: Re: Bug#178583: Documentation (partial) written

Date: Wed, 23 Jul 2003 17:20:35 +0200

On Wed, Jul 23, 2003 at 07:35:13AM +1000, Matthew Palmer wrote:
> On Tue, Jul 22, 2003 at 02:21:30PM +0200, Ola Lundqvist wrote:
> > Ok. It might be better to write it in docbook or something that I can
> > manage without a bigger problem. On the other hand it is a lot better with
> > a manpage than without one. :) Thanks again.
> 
> I guess it can live as-is for now, then when you get time you can can
> reformat it into docbook.  I'm going to be no good for that, as I've never
> used docbook in my life...

Ok, I'll apply it as it (I think).

> > > > I also think about making wwwconfig-common more general in that you can
> > > > configure more things than web-related things. What do you think about
> > > > such an idea?
> > > 
> > > Hmm, how general were you planning on going?  I think there has to be a
> > > limit to how broad wwwconfig-common should go, but there is more stuff that
> > > could go in, I'm sure.
> > 
> > I'm planning on a generic interface for configuring other packages.
> > Of course it has to be renamed then. wwwconfig-common is basically
> > just an interface on how to configure exim, mysql, postgres,
> > php and apache. This should be possible to generalize.
> 
> You're thinking sort of update-inetd for everything, right?  I'd say "yes,
> good idea", but put the config scripts in with the packages you're working
> with.  wwwconfig-common works well because (a) there's three types of apache
> you could touch; (b) two types of PHP, and (c) two types of DB, both of
> which might not actually be on the local machine.  For other, more "regular"
> packages, I don't think there'd be much of a need to have a separate
> configuration package (either one-by-one, or in a great mass), so you could
> incorporate the necessary scripts into the package and all would be lovely.

True. But it should be in a common place to make sure that you can
easily find and manage it.

> As long as it was all documented, of course.  <grin>

:))

Regards,

// Ola

> - Matt

-- 
 --------------------- Ola Lundqvist ---------------------------
/  [email protected]                     Annebergsslingan 37      \
|  [email protected]                 654 65 KARLSTAD          |
|  +46 (0)54-10 14 30                  +46 (0)70-332 1551       |
|  http://www.opal.dhs.org             UIN/icq: 4912500         |
\  gpg/f.p.: 7090 A92B 18FE 7994 0C36  4FE4 18A1 B1CF 0FE5 3DD9 /
 ---------------------------------------------------------------

Send a report that this bug log contains spam.