Re: Creating man pages (upstream does not have one)

2001-05-14 Thread Shaul Karl
> 
> Try using manedit, it's quite friendly :) gtk/gnome, multi-windowed stuff.
> http://wolfpack.twu.net/ManEdit/
> but you better check the syntax of your manpages after !
> i used it to create a manpage for my package.
> it would be great to have this software in debian too :))
> (i dont use it much, i don't know it well)
> 
> jean marc
> 
> >
> > The software I am packaging does not have a man page.
> >
> > What programs should I use to create one?
> >



Another solution might be the LDP Man-Page mini-HOWTO + man (7) + taking 
examples from some existing man page sources.
Although not a program, IMHO that mini-HOWTO can get you started quicker then 
you think.



> > Thanks, Eduardo.
> >
> >
> > --
> > To UNSUBSCRIBE, email to [EMAIL PROTECTED]
> > with a subject of "unsubscribe". Trouble? Contact
> [EMAIL PROTECTED]
> >
> 
>  
> __
> ifrance.com, l'email gratuit le plus complet de l'Internet !
> vos emails depuis un navigateur, en POP3, sur Minitel, sur le WAP...
> http://www.ifrance.com/_reloc/email.emailif
> 
> 
> 
> --  
> To UNSUBSCRIBE, email to [EMAIL PROTECTED]
> with a subject of "unsubscribe". Trouble? Contact [EMAIL PROTECTED]
> 

-- 

Shaul Karl <[EMAIL PROTECTED]>

Hillel used to say: If I am not for myself who will be for me?
Yet, if I am for myself only, what am I? And if not now, when?
  (Ethics Of The Fathers 1:14)




-- 

Shaul Karl <[EMAIL PROTECTED]>

Hillel used to say: If I am not for myself who will be for me?
Yet, if I am for myself only, what am I? And if not now, when?
  (Ethics Of The Fathers 1:14)





Re: Creating man pages (upstream does not have one)

2001-05-14 Thread Shaul Karl

> 
> Try using manedit, it's quite friendly :) gtk/gnome, multi-windowed stuff.
> http://wolfpack.twu.net/ManEdit/
> but you better check the syntax of your manpages after !
> i used it to create a manpage for my package.
> it would be great to have this software in debian too :))
> (i dont use it much, i don't know it well)
> 
> jean marc
> 
> >
> > The software I am packaging does not have a man page.
> >
> > What programs should I use to create one?
> >



Another solution might be the LDP Man-Page mini-HOWTO + man (7) + taking 
examples from some existing man page sources.
Although not a program, IMHO that mini-HOWTO can get you started quicker then 
you think.



> > Thanks, Eduardo.
> >
> >
> > --
> > To UNSUBSCRIBE, email to [EMAIL PROTECTED]
> > with a subject of "unsubscribe". Trouble? Contact
> [EMAIL PROTECTED]
> >
> 
>  
> __
> ifrance.com, l'email gratuit le plus complet de l'Internet !
> vos emails depuis un navigateur, en POP3, sur Minitel, sur le WAP...
> http://www.ifrance.com/_reloc/email.emailif
> 
> 
> 
> --  
> To UNSUBSCRIBE, email to [EMAIL PROTECTED]
> with a subject of "unsubscribe". Trouble? Contact [EMAIL PROTECTED]
> 

-- 

Shaul Karl <[EMAIL PROTECTED]>

Hillel used to say: If I am not for myself who will be for me?
Yet, if I am for myself only, what am I? And if not now, when?
  (Ethics Of The Fathers 1:14)




-- 

Shaul Karl <[EMAIL PROTECTED]>

Hillel used to say: If I am not for myself who will be for me?
Yet, if I am for myself only, what am I? And if not now, when?
  (Ethics Of The Fathers 1:14)




--  
To UNSUBSCRIBE, email to [EMAIL PROTECTED]
with a subject of "unsubscribe". Trouble? Contact [EMAIL PROTECTED]




Re: Creating man pages (upstream does not have one)

2001-05-14 Thread JM Bourdaret

Try using manedit, it's quite friendly :) gtk/gnome, multi-windowed stuff.
http://wolfpack.twu.net/ManEdit/
but you better check the syntax of your manpages after !
i used it to create a manpage for my package.
it would be great to have this software in debian too :))
(i dont use it much, i don't know it well)

jean marc

>
> The software I am packaging does not have a man page.
>
> What programs should I use to create one?
>
> Thanks, Eduardo.
>
>
> --
> To UNSUBSCRIBE, email to [EMAIL PROTECTED]
> with a subject of "unsubscribe". Trouble? Contact
[EMAIL PROTECTED]
>

 
__
ifrance.com, l'email gratuit le plus complet de l'Internet !
vos emails depuis un navigateur, en POP3, sur Minitel, sur le WAP...
http://www.ifrance.com/_reloc/email.emailif




Re: Creating man pages (upstream does not have one)

2001-05-14 Thread JM Bourdaret


Try using manedit, it's quite friendly :) gtk/gnome, multi-windowed stuff.
http://wolfpack.twu.net/ManEdit/
but you better check the syntax of your manpages after !
i used it to create a manpage for my package.
it would be great to have this software in debian too :))
(i dont use it much, i don't know it well)

jean marc

>
> The software I am packaging does not have a man page.
>
> What programs should I use to create one?
>
> Thanks, Eduardo.
>
>
> --
> To UNSUBSCRIBE, email to [EMAIL PROTECTED]
> with a subject of "unsubscribe". Trouble? Contact
[EMAIL PROTECTED]
>

 
__
ifrance.com, l'email gratuit le plus complet de l'Internet !
vos emails depuis un navigateur, en POP3, sur Minitel, sur le WAP...
http://www.ifrance.com/_reloc/email.emailif



--  
To UNSUBSCRIBE, email to [EMAIL PROTECTED]
with a subject of "unsubscribe". Trouble? Contact [EMAIL PROTECTED]




Re: Creating man pages (upstream does not have one)

2001-05-11 Thread Eric Van Buggenhaut
On Sat, May 12, 2001 at 01:27:04AM +0900, Junichi Uekawa wrote:
> Othmar Pasteka <[EMAIL PROTECTED]> cum veritate scripsit:
> 
> Hmm... anyone going to package manedit ?
> I tried it. It was rather fun to play with. It edits in roff.
> 
> Should I upload it ?

IIRC, [EMAIL PROTECTED] is maintainer for that package.

-- 
Eric VAN BUGGENHAUT

[EMAIL PROTECTED]



Re: Creating man pages (upstream does not have one)

2001-05-11 Thread Eric Van Buggenhaut

On Sat, May 12, 2001 at 01:27:04AM +0900, Junichi Uekawa wrote:
> Othmar Pasteka <[EMAIL PROTECTED]> cum veritate scripsit:
> 
> Hmm... anyone going to package manedit ?
> I tried it. It was rather fun to play with. It edits in roff.
> 
> Should I upload it ?

IIRC, [EMAIL PROTECTED] is maintainer for that package.

-- 
Eric VAN BUGGENHAUT

[EMAIL PROTECTED]


--  
To UNSUBSCRIBE, email to [EMAIL PROTECTED]
with a subject of "unsubscribe". Trouble? Contact [EMAIL PROTECTED]




Re: Creating man pages (upstream does not have one)

2001-05-11 Thread Junichi Uekawa
Othmar Pasteka <[EMAIL PROTECTED]> cum veritate scripsit:

Hmm... anyone going to package manedit ?
I tried it. It was rather fun to play with. It edits in roff.

Should I upload it ?

regards,
junichi

-- 
[EMAIL PROTECTED]  http://www.netfort.gr.jp/~dancer
-BEGIN GEEK CODE BLOCK-
Version: 3.12
GE d+ s:- a-- C+ UL P- L+++ E W++ N o-- K- w++ 
O- M- V-- PS+ PE-- Y+ PGP+ t-- 5 X-- R* tv- b+ DI- D++ 
G e h* r% !y+ 
--END GEEK CODE BLOCK--





Re: Creating man pages (upstream does not have one)

2001-05-11 Thread Junichi Uekawa

Othmar Pasteka <[EMAIL PROTECTED]> cum veritate scripsit:

Hmm... anyone going to package manedit ?
I tried it. It was rather fun to play with. It edits in roff.

Should I upload it ?

regards,
junichi

-- 
[EMAIL PROTECTED]  http://www.netfort.gr.jp/~dancer
-BEGIN GEEK CODE BLOCK-
Version: 3.12
GE d+ s:- a-- C+ UL P- L+++ E W++ N o-- K- w++ 
O- M- V-- PS+ PE-- Y+ PGP+ t-- 5 X-- R* tv- b+ DI- D++ 
G e h* r% !y+ 
--END GEEK CODE BLOCK--




--  
To UNSUBSCRIBE, email to [EMAIL PROTECTED]
with a subject of "unsubscribe". Trouble? Contact [EMAIL PROTECTED]




Re: Creating man pages (upstream does not have one)

2001-05-10 Thread Luis Arocha -data-
Y el jueves 10 de mayo, Eduardo Trapani escribió:
> 
> The software I am packaging does not have a man page.
> 
> What programs should I use to create one?
> 
> Thanks, Eduardo.
> 
My suggestion:
Use perldoc, you will write a txt file like this and you will get a
pretty manpage with only one command:

glade manpage source [only some lines]:
- cut ---
=head1 NAME

glade - Rapid Development Application tool using Gtk+/Gnome libraries.

=head1 SYNOPSIS

  glade [OPTION...]

=head1 DESCRIPTION

Glade is an application for creating graphical user interfaces that use the
Gtk+ and GNOME libraries.  Glade allows you to rapidly develope these
interfaces, and can create source code in a variety of languages that will
construct the interfaces for you. Glade can also be used in conjunction with
libglade to dynamically create user interfaces from the XML description file
that Glade creates.

=head1 OPTIONS

=over 4

=item B<--disable-sound>

Disable sound server use.

=back

=head1 FILES

=head2 The Glade XML File Format

TheGlade XML file format is used when saving and loading projects in Glade.
This format is also intended to be read by programs which convert it into
source code in various languages.


=head1 CAVEATS

Here are some notes about problems which may be encountered when using Glade.

=over 4

=item 

Some properties which can only be set when a widget is created or before it is
realized.

e.g. window - wmclass, wmname

image - type & visual (mentioned above)
clist/ctree - number of columns
 
=back

=head1 SEE ALSO

To obtain more information about Glade please visit L.

=head1 COPYRIGHT

This package is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; version 2 dated June, 1991.

=head1 AUTHORS

  Damon Chaplin <[EMAIL PROTECTED]>
  Martijn van Beers <[EMAIL PROTECTED]>

- cut ---

command to obtain glade.1:

pod2man -r '' -c '' glade.pod>glade.1

HTH
Saludos

-- 
   O /  >O >O >O >O O / O / O / O /  >O  Luis Arocha, "Data"
\__|/|__|__|__|/ \__|/__|/__|/__|/|/ larocha at wanadoo.es
\\   \   \   \   Islas Canarias
  \\   \   \   \ Spain



pgpkHAWhYTM8Y.pgp
Description: PGP signature


Re: Creating man pages (upstream does not have one)

2001-05-10 Thread Othmar Pasteka
hi,

On Thu, May 10, 2001 at 09:42:51PM +0200, Jérôme Marant wrote:
>   I would recommend to write them in the POD (Plain Old Documentation)
>   format which makes it very seasy to write/update a man page.
>   (see http://qa.debian.org/man-pages.html for pointers to documentations).

haven't dealt with it but i saw some examples and wasn't that
conviced ...

>   I would NOT recommend to use the native manpage format (nroff) nor the
>   DocBook SGML format since writing a manpage with them is rather
>   respectively confusing/painful, IMHO.

plain wrong ... nroff is not hard or something like that, read
the manpage howto and you know how to do it and there is also
plenty of stuff about it lying around ... and i did a rather
lengthy manpage with the an macro package and it was all but not
a pain ... if *roff is a pain why do people use latex, eh? ...
anyway, i don't consider it difficult, just different ... and an
easy manpage is written in a few minutes.

so long
Othmar



Re: Creating man pages (upstream does not have one)

2001-05-10 Thread Jérôme Marant
En réponse à Eduardo Trapani <[EMAIL PROTECTED]>:

> 
> The software I am packaging does not have a man page.
> 
> What programs should I use to create one?

  I would recommend to write them in the POD (Plain Old Documentation)
  format which makes it very seasy to write/update a man page.
  (see http://qa.debian.org/man-pages.html for pointers to documentations).

  I would NOT recommend to use the native manpage format (nroff) nor the
  DocBook SGML format since writing a manpage with them is rather
  respectively confusing/painful, IMHO.

Jérôme.



Re: Creating man pages (upstream does not have one)

2001-05-10 Thread Othmar Pasteka
hi,

On Thu, May 10, 2001 at 03:52:30PM -0300, Eduardo Trapani wrote:
> What programs should I use to create one?

the normal groff and the an macro (on the commandline that's the
-man ;)) ... read the manpage howto as a start and also read man
7 man ... 

so long
Othmar



Re: Creating man pages (upstream does not have one)

2001-05-10 Thread Falk Hueffner
Eduardo Trapani <[EMAIL PROTECTED]> writes:

> The software I am packaging does not have a man page.
> 
> What programs should I use to create one?

Try using help2man to get a good template, and edit it by hand.

Falk



Re: Creating man pages (upstream does not have one)

2001-05-10 Thread Peter S Galbraith

Eduardo Trapani wrote:

> The software I am packaging does not have a man page.
> 
> What programs should I use to create one?

I usually just edit one directly (in roff).

I'm pretty sure dh_make installs a sample.  If it doesn't, look
at /usr/share/debhelper/dh_make/debian/manpage.1.ex

There's also /usr/share/doc/man-db/examples/manpage.example

Peter



Re: Creating man pages (upstream does not have one)

2001-05-10 Thread Sami Haahtinen
On Thu, May 10, 2001 at 03:52:30PM -0300, Eduardo Trapani wrote:
> 
> The software I am packaging does not have a man page.
> 
> What programs should I use to create one?

the best, but definitely not the easiest one, is to just get an example page
and edit it by hand. there are programs like manedit for X that you can use. of
you can use other tools to create one. SGML is one format that can be converted
to manpages (if you know it already)

-- 
  -< Sami Haahtinen >-
-< 2209 3C53 D0FB 041C F7B1  F908 A9B6 F730 B83D 761C >-



Re: Creating man pages (upstream does not have one)

2001-05-10 Thread Warren Anthony Stramiello
When you use debmake (the first thing you run on the clean source dir, if
I'm not mistaken), it will create the debian directory. Check in there for
a manpage.1.ex file that serves as a good template for the process.

~Warren



Creating man pages (upstream does not have one)

2001-05-10 Thread Eduardo Trapani

The software I am packaging does not have a man page.

What programs should I use to create one?

Thanks, Eduardo.



Re: Creating man pages (upstream does not have one)

2001-05-10 Thread Luis Arocha -data-

Y el jueves 10 de mayo, Eduardo Trapani escribió:
> 
> The software I am packaging does not have a man page.
> 
> What programs should I use to create one?
> 
> Thanks, Eduardo.
> 
My suggestion:
Use perldoc, you will write a txt file like this and you will get a
pretty manpage with only one command:

glade manpage source [only some lines]:
- cut ---
=head1 NAME

glade - Rapid Development Application tool using Gtk+/Gnome libraries.

=head1 SYNOPSIS

  glade [OPTION...]

=head1 DESCRIPTION

Glade is an application for creating graphical user interfaces that use the
Gtk+ and GNOME libraries.  Glade allows you to rapidly develope these
interfaces, and can create source code in a variety of languages that will
construct the interfaces for you. Glade can also be used in conjunction with
libglade to dynamically create user interfaces from the XML description file
that Glade creates.

=head1 OPTIONS

=over 4

=item B<--disable-sound>

Disable sound server use.

=back

=head1 FILES

=head2 The Glade XML File Format

TheGlade XML file format is used when saving and loading projects in Glade.
This format is also intended to be read by programs which convert it into
source code in various languages.


=head1 CAVEATS

Here are some notes about problems which may be encountered when using Glade.

=over 4

=item 

Some properties which can only be set when a widget is created or before it is
realized.

e.g. window - wmclass, wmname

image - type & visual (mentioned above)
clist/ctree - number of columns
 
=back

=head1 SEE ALSO

To obtain more information about Glade please visit L.

=head1 COPYRIGHT

This package is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; version 2 dated June, 1991.

=head1 AUTHORS

  Damon Chaplin <[EMAIL PROTECTED]>
  Martijn van Beers <[EMAIL PROTECTED]>

- cut ---

command to obtain glade.1:

pod2man -r '' -c '' glade.pod>glade.1

HTH
Saludos

-- 
   O /  >O >O >O >O O / O / O / O /  >O  Luis Arocha, "Data"
\__|/|__|__|__|/ \__|/__|/__|/__|/|/ larocha at wanadoo.es
\\   \   \   \   Islas Canarias
  \\   \   \   \ Spain


 PGP signature


Re: Creating man pages (upstream does not have one)

2001-05-10 Thread Othmar Pasteka

hi,

On Thu, May 10, 2001 at 09:42:51PM +0200, Jérôme Marant wrote:
>   I would recommend to write them in the POD (Plain Old Documentation)
>   format which makes it very seasy to write/update a man page.
>   (see http://qa.debian.org/man-pages.html for pointers to documentations).

haven't dealt with it but i saw some examples and wasn't that
conviced ...

>   I would NOT recommend to use the native manpage format (nroff) nor the
>   DocBook SGML format since writing a manpage with them is rather
>   respectively confusing/painful, IMHO.

plain wrong ... nroff is not hard or something like that, read
the manpage howto and you know how to do it and there is also
plenty of stuff about it lying around ... and i did a rather
lengthy manpage with the an macro package and it was all but not
a pain ... if *roff is a pain why do people use latex, eh? ...
anyway, i don't consider it difficult, just different ... and an
easy manpage is written in a few minutes.

so long
Othmar


--  
To UNSUBSCRIBE, email to [EMAIL PROTECTED]
with a subject of "unsubscribe". Trouble? Contact [EMAIL PROTECTED]




Re: Creating man pages (upstream does not have one)

2001-05-10 Thread Jérôme Marant

En réponse à Eduardo Trapani <[EMAIL PROTECTED]>:

> 
> The software I am packaging does not have a man page.
> 
> What programs should I use to create one?

  I would recommend to write them in the POD (Plain Old Documentation)
  format which makes it very seasy to write/update a man page.
  (see http://qa.debian.org/man-pages.html for pointers to documentations).

  I would NOT recommend to use the native manpage format (nroff) nor the
  DocBook SGML format since writing a manpage with them is rather
  respectively confusing/painful, IMHO.

Jérôme.


--  
To UNSUBSCRIBE, email to [EMAIL PROTECTED]
with a subject of "unsubscribe". Trouble? Contact [EMAIL PROTECTED]




Re: Creating man pages (upstream does not have one)

2001-05-10 Thread Othmar Pasteka

hi,

On Thu, May 10, 2001 at 03:52:30PM -0300, Eduardo Trapani wrote:
> What programs should I use to create one?

the normal groff and the an macro (on the commandline that's the
-man ;)) ... read the manpage howto as a start and also read man
7 man ... 

so long
Othmar


--  
To UNSUBSCRIBE, email to [EMAIL PROTECTED]
with a subject of "unsubscribe". Trouble? Contact [EMAIL PROTECTED]




Re: Creating man pages (upstream does not have one)

2001-05-10 Thread Falk Hueffner

Eduardo Trapani <[EMAIL PROTECTED]> writes:

> The software I am packaging does not have a man page.
> 
> What programs should I use to create one?

Try using help2man to get a good template, and edit it by hand.

Falk


--  
To UNSUBSCRIBE, email to [EMAIL PROTECTED]
with a subject of "unsubscribe". Trouble? Contact [EMAIL PROTECTED]




Re: Creating man pages (upstream does not have one)

2001-05-10 Thread Peter S Galbraith


Eduardo Trapani wrote:

> The software I am packaging does not have a man page.
> 
> What programs should I use to create one?

I usually just edit one directly (in roff).

I'm pretty sure dh_make installs a sample.  If it doesn't, look
at /usr/share/debhelper/dh_make/debian/manpage.1.ex

There's also /usr/share/doc/man-db/examples/manpage.example

Peter


--  
To UNSUBSCRIBE, email to [EMAIL PROTECTED]
with a subject of "unsubscribe". Trouble? Contact [EMAIL PROTECTED]




Re: Creating man pages (upstream does not have one)

2001-05-10 Thread Sami Haahtinen

On Thu, May 10, 2001 at 03:52:30PM -0300, Eduardo Trapani wrote:
> 
> The software I am packaging does not have a man page.
> 
> What programs should I use to create one?

the best, but definitely not the easiest one, is to just get an example page
and edit it by hand. there are programs like manedit for X that you can use. of
you can use other tools to create one. SGML is one format that can be converted
to manpages (if you know it already)

-- 
  -< Sami Haahtinen >-
-< 2209 3C53 D0FB 041C F7B1  F908 A9B6 F730 B83D 761C >-


--  
To UNSUBSCRIBE, email to [EMAIL PROTECTED]
with a subject of "unsubscribe". Trouble? Contact [EMAIL PROTECTED]




Re: Creating man pages (upstream does not have one)

2001-05-10 Thread Warren Anthony Stramiello

When you use debmake (the first thing you run on the clean source dir, if
I'm not mistaken), it will create the debian directory. Check in there for
a manpage.1.ex file that serves as a good template for the process.

~Warren


--  
To UNSUBSCRIBE, email to [EMAIL PROTECTED]
with a subject of "unsubscribe". Trouble? Contact [EMAIL PROTECTED]




Creating man pages (upstream does not have one)

2001-05-10 Thread Eduardo Trapani


The software I am packaging does not have a man page.

What programs should I use to create one?

Thanks, Eduardo.


--  
To UNSUBSCRIBE, email to [EMAIL PROTECTED]
with a subject of "unsubscribe". Trouble? Contact [EMAIL PROTECTED]