Re: [DNG] netman: adding adequate help
Hi, I have just 'git pushed' the netman changes to support a manpage. Now, using 'man netman' displays netman's help in the form a manpage. Edward On 30/01/2016, Edward Bartolo wrote: > Hi, > > The manpage's source file, netman.1, is ready and I also added > netman.1.gz to netman's sources. I can instruct netman-backend.install > to copy netman.1.gz to /usr/share/man/man1. > > What should I do? > > Edward > ___ Dng mailing list Dng@lists.dyne.org https://mailinglists.dyne.org/cgi-bin/mailman/listinfo/dng
Re: [DNG] netman: adding adequate help
Hi, The manpage's source file, netman.1, is ready and I also added netman.1.gz to netman's sources. I can instruct netman-backend.install to copy netman.1.gz to /usr/share/man/man1. What should I do? Edward ___ Dng mailing list Dng@lists.dyne.org https://mailinglists.dyne.org/cgi-bin/mailman/listinfo/dng
Re: [DNG] netman: adding adequate help
Hi, I think, the manpage should be part of netman-backend as this is a dependency of netman-gui. Where in the source's tree should I place the source for the manpage and in what format should this file be? I can manually create a netman-backend.manpages file. Edward On 30/01/2016, Rainer Weikusat wrote: > Edward Bartolo writes: >> I can now view the newly created netman page using the command: >> groff -man -Tascii ./netman-0.1.1/netman0.1.1.man | less >> >> The man page looks correct. Now the question is: How am I going to add >> the man page to my netman project? > > The file should have a section number as extensions, presumaby 1 (user > commands) in your case. According to the documentation for that > (dh_installman(1)), a file debian/.manpages listing all > man pages can be used to have them installed automatically. > > BTW: The command > > man -l > > can be used to format and display a man page from some 'local' file > instead of from the man pages directory tree. > ___ > Dng mailing list > Dng@lists.dyne.org > https://mailinglists.dyne.org/cgi-bin/mailman/listinfo/dng > ___ Dng mailing list Dng@lists.dyne.org https://mailinglists.dyne.org/cgi-bin/mailman/listinfo/dng
Re: [DNG] netman: adding adequate help
Edward Bartolo writes: > I can now view the newly created netman page using the command: > groff -man -Tascii ./netman-0.1.1/netman0.1.1.man | less > > The man page looks correct. Now the question is: How am I going to add > the man page to my netman project? The file should have a section number as extensions, presumaby 1 (user commands) in your case. According to the documentation for that (dh_installman(1)), a file debian/.manpages listing all man pages can be used to have them installed automatically. BTW: The command man -l can be used to format and display a man page from some 'local' file instead of from the man pages directory tree. ___ Dng mailing list Dng@lists.dyne.org https://mailinglists.dyne.org/cgi-bin/mailman/listinfo/dng
Re: [DNG] netman: adding adequate help
Hi, I can now view the newly created netman page using the command: groff -man -Tascii ./netman-0.1.1/netman0.1.1.man | less The man page looks correct. Now the question is: How am I going to add the man page to my netman project? Edward ___ Dng mailing list Dng@lists.dyne.org https://mailinglists.dyne.org/cgi-bin/mailman/listinfo/dng
Re: [DNG] netman: adding adequate help
On 12/01/16 09:09, Rainer Weikusat wrote: > Daniel Reurich writes: >>> As a packager how do I make sure README is actually installed? >> >> use dh_installman - and read the manpage for it >> >> :D > > dh_installman is for installing man pages, not for other documentation > (eg, README files). It will (like dh_installdocs) be invoked > automatically as part of the dh 'binary' sequence. Oops, yeah should use dh_installdocs for that. just create 'debian/.docs' containing a line with README There is a bunch of files that are automatically handled... see dh_installdocs man page for details. -- Daniel Reurich Centurion Computer Technology (2005) Ltd. 021 797 722 signature.asc Description: OpenPGP digital signature ___ Dng mailing list Dng@lists.dyne.org https://mailinglists.dyne.org/cgi-bin/mailman/listinfo/dng
Re: [DNG] netman: adding adequate help
Daniel Reurich writes: >> As a packager how do I make sure README is actually installed? > > use dh_installman - and read the manpage for it > > :D dh_installman is for installing man pages, not for other documentation (eg, README files). It will (like dh_installdocs) be invoked automatically as part of the dh 'binary' sequence. ___ Dng mailing list Dng@lists.dyne.org https://mailinglists.dyne.org/cgi-bin/mailman/listinfo/dng
Re: [DNG] netman: adding adequate help
> As a packager how do I make sure README is actually installed? use dh_installman - and read the manpage for it :D -- Daniel Reurich Centurion Computer Technology (2005) Ltd. 021 797 722 signature.asc Description: OpenPGP digital signature ___ Dng mailing list Dng@lists.dyne.org https://mailinglists.dyne.org/cgi-bin/mailman/listinfo/dng
Re: [DNG] netman: adding adequate help
I created a basic manpage for the backend here: https://git.devuan.org/rwhite/netman/blob/master/backend_src/netman-backend.8 -Rich ___ Dng mailing list Dng@lists.dyne.org https://mailinglists.dyne.org/cgi-bin/mailman/listinfo/dng
Re: [DNG] netman: adding adequate help
On Mon, Jan 11, 2016 at 03:55:20PM +, Rainer Weikusat wrote: > Edward Bartolo writes: > > > 1) Should I add a manpage so that 'man netman' works? > > The Debian policy used to require this. And still does. -- A tit a day keeps the vet away. ___ Dng mailing list Dng@lists.dyne.org https://mailinglists.dyne.org/cgi-bin/mailman/listinfo/dng
Re: [DNG] netman: adding adequate help
Edward Bartolo writes: > Hi, > > 1) Should I add a manpage so that 'man netman' works? The Debian policy used to require this. > 2) Netman frontend uses README as a help file which is saved under > /usr/share/netman. Should I include lines in netman-gui.install like > the following? > README /usr/share/netman > NETMAN.HELP /usr/share/netman > > NETMAN.HELP is a symbolic link pointing to README. > > As a packager how do I make sure README is actually installed? There's a default top-level directory for documentation, /usr/share/doc. The debian/changelog file and any README files below debian will automatically be installed into /usr/share/doc/. The file debian/.docs can be used to list addtional files also supposed to be put into this directory. See dh_installdocs(1) for a detailed description. ___ Dng mailing list Dng@lists.dyne.org https://mailinglists.dyne.org/cgi-bin/mailman/listinfo/dng
Re: [DNG] netman: adding adequate help
Edward Bartolo [2016-01-11 10:33]: > 1) Should I add a manpage so that 'man netman' works? Most definitely yes. All programs should have a manpage, at least to show where documentation can be found. -- Hilsen Harald ___ Dng mailing list Dng@lists.dyne.org https://mailinglists.dyne.org/cgi-bin/mailman/listinfo/dng
[DNG] netman: adding adequate help
Hi, 1) Should I add a manpage so that 'man netman' works? 2) Netman frontend uses README as a help file which is saved under /usr/share/netman. Should I include lines in netman-gui.install like the following? README /usr/share/netman NETMAN.HELP /usr/share/netman NETMAN.HELP is a symbolic link pointing to README. As a packager how do I make sure README is actually installed? Edward ___ Dng mailing list Dng@lists.dyne.org https://mailinglists.dyne.org/cgi-bin/mailman/listinfo/dng