Man page not in the right directory

Moderators: jbeuken, jzwanzig, gonze

Man page not in the right directory

Postby renatomiceli » Sat Jul 21, 2012 8:44 pm

Hi all,

after installing ABINIT, its manual page can be found in share/doc/abinit/manpages. However, man won't find any entry for "abinit" even if this directory is appended to MANPATH, since man only finds pages in directories man1/, man2/, man3/, ... So one has to manually create a directory "man1" and place "abinit.1" there. I understand this is pretty simple, so can we fix the makefile to place "abinit.1" in its right "man1" directory?

It is worth noticing that this man page is out-of-date, as it hasn't been updated since v. 4.5 as of v. 6.12.3.

Kind regards,
Renato Miceli
Mr. Renato Miceli
Independent HPC & Supercomputing Consultant
http://renatomiceli.com/
renatomiceli
 
Posts: 10
Joined: Sat Jul 21, 2012 4:11 pm
Location: Salvador da Bahia, Brazil

Re: Man page not in the right directory

Postby pouillon » Wed Aug 01, 2012 6:52 pm

FYI: manpages will be rewritten and properly integrated in Abinit 7.
Yann Pouillon
Simune Atomistics
Donostia-San Sebastián, Spain
User avatar
pouillon
 
Posts: 645
Joined: Wed Aug 19, 2009 10:08 am
Location: Spain

Re: Man page not in the right directory

Postby renatomiceli » Wed Aug 08, 2012 1:14 pm

pouillon wrote:FYI: manpages will be rewritten and properly integrated in Abinit 7.

Hi Yann,

when is Abinit 7 planned to be released?

Kind regards,
Renato Miceli
Mr. Renato Miceli
Independent HPC & Supercomputing Consultant
http://renatomiceli.com/
renatomiceli
 
Posts: 10
Joined: Sat Jul 21, 2012 4:11 pm
Location: Salvador da Bahia, Brazil

Re: Man page not in the right directory

Postby pouillon » Tue Aug 14, 2012 7:31 pm

Yann Pouillon
Simune Atomistics
Donostia-San Sebastián, Spain
User avatar
pouillon
 
Posts: 645
Joined: Wed Aug 19, 2009 10:08 am
Location: Spain

Re: Man page not in the right directory

Postby renatomiceli » Tue Aug 14, 2012 9:53 pm

pouillon wrote:October or November this year:

http://www.abinit.org/developers/abinit ... -of-merges

Thank you, Yann. Looking forward to it!

Kind regards,
Renato Miceli
Mr. Renato Miceli
Independent HPC & Supercomputing Consultant
http://renatomiceli.com/
renatomiceli
 
Posts: 10
Joined: Sat Jul 21, 2012 4:11 pm
Location: Salvador da Bahia, Brazil

Re: Man page not in the right directory

Postby renatomiceli » Sat Dec 01, 2012 4:10 am

Hi Yann,

first, thank you very much for releasing Abinit 7.0.3. This version certainly brings very interesting features and fixes! Thanks!

In the meantime, I realized that Abinit's manpage has not changed since version 6.12.3. I really appreciate if you could keep me informed about your future plans for the manpages. Could you let me know when we should expect any updates? :)

I understand this is low priority. My idea is just to clarify the next steps to our local Abinit users.
Thank you in advance for your time and patience!

Kind regards,
Renato Miceli
Mr. Renato Miceli
Independent HPC & Supercomputing Consultant
http://renatomiceli.com/
renatomiceli
 
Posts: 10
Joined: Sat Jul 21, 2012 4:11 pm
Location: Salvador da Bahia, Brazil

Re: Man page not in the right directory

Postby pouillon » Tue Dec 11, 2012 2:03 pm

I've scheduled the improvement of manpages for version 7.1. If I'm not able to achieve it, I'll reschedule it for a little coding party a few of us are having in April. In the worst case, this will be available in May 2013. In the best case, in January 2013.
Yann Pouillon
Simune Atomistics
Donostia-San Sebastián, Spain
User avatar
pouillon
 
Posts: 645
Joined: Wed Aug 19, 2009 10:08 am
Location: Spain

Re: Man page not in the right directory

Postby pouillon » Tue Oct 22, 2013 1:06 pm

Well, the current funding situation in Spain has brought me to other priorities. I'll put it back to my todo list and see what I can do to improve the manpages.
Yann Pouillon
Simune Atomistics
Donostia-San Sebastián, Spain
User avatar
pouillon
 
Posts: 645
Joined: Wed Aug 19, 2009 10:08 am
Location: Spain

Re: Man page not in the right directory

Postby renatomiceli » Thu Jun 26, 2014 10:53 pm

No problem, Yann.

I reckon fixing the build system to publish the manpages under the likes of share/man/man1/ should be simple to perform.
Then they need to be updated but this often takes longer.

Please let me know when the improvements are underway.
Mr. Renato Miceli
Independent HPC & Supercomputing Consultant
http://renatomiceli.com/
renatomiceli
 
Posts: 10
Joined: Sat Jul 21, 2012 4:11 pm
Location: Salvador da Bahia, Brazil

Re: Man page not in the right directory

Postby pouillon » Fri Jun 27, 2014 11:54 am

Man pages should already be correctly installed in the upcoming 7.8 version of Abinit. If this is not the case yet, everything will be fixed for Abinit 8.0, expected by the end of the year, including the missing man pages.

I'm currently exploring how to have the man pages maintained on the upcoming Abinit Wiki --- which is based on Dokuwiki --- and then transferred automatically to the abinit-doc source package at each release. I already have a good idea of the workflow if I use Pandoc, but I still neeed to decide which intermediate format will be the best to get automatic validation and rendering of the pages. Any opinion on this will be gladly welcome.
Yann Pouillon
Simune Atomistics
Donostia-San Sebastián, Spain
User avatar
pouillon
 
Posts: 645
Joined: Wed Aug 19, 2009 10:08 am
Location: Spain


Return to Testing and Documentation

Who is online

Users browsing this forum: No registered users and 1 guest