Building Grub2 manual?

Building Grub2 manual?

[BandiPat]

Quick question guys!  I notice there is a grub.texi file that is suppose 
to be built as a grub.info.gz during the build, which gives you the new 
manual?

I'm not getting that with my build.  Now maybe I don't have a program 
installed it needs to make that conversion, but I do not get any 
complaints from the build about something missing.  I do get an odd 
empty /boot/info directory though, but this probably doesn't have 
anything to do with the manual build.

Normally there is a manual file in different form which creates 
something you can read using the "man grub" command, but it appears you 
guys went another way?

TIA,
Pat


-- 
        ---Zenwalk v6.x--Linux 2.6.31---
"In brightest day, in darkest night, let those
that worship evil, beware Green Lantern's Light!"

Re: Building Grub2 manual?

[Bruce Dubbs]

BandiPat wrote:
> Quick question guys!  I notice there is a grub.texi file that is suppose 
> to be built as a grub.info.gz during the build, which gives you the new 
> manual?
> 
> I'm not getting that with my build.  Now maybe I don't have a program 
> installed it needs to make that conversion, but I do not get any 
> complaints from the build about something missing.  I do get an odd 
> empty /boot/info directory though, but this probably doesn't have 
> anything to do with the manual build.
> 
> Normally there is a manual file in different form which creates 
> something you can read using the "man grub" command, but it appears you 
> guys went another way?

I'm working on the documentation, but it's not very close to a point 
where I can submit it yet.  I intend to be able to have html, man and 
info files available from the .texi base.

In the meantime, I'd recommend browsing the wiki.

http://grub.enbug.org/

   -- Bruce

Re: Building Grub2 manual?

[Colin Watson]

On Sat, Jan 30, 2010 at 08:25:31PM -0500, BandiPat wrote:
> Quick question guys!  I notice there is a grub.texi file that is suppose  
> to be built as a grub.info.gz during the build, which gives you the new  
> manual?
>
> I'm not getting that with my build.  Now maybe I don't have a program  
> installed it needs to make that conversion, but I do not get any  
> complaints from the build about something missing.

You need the 'makeinfo' program installed.  It's optional, so the build
won't fail if it's missing.

> Normally there is a manual file in different form which creates  
> something you can read using the "man grub" command, but it appears you  
> guys went another way?

info and man are different styles of documentation.  Manual pages tend
to have a quick-reference flavour, whereas info pages are a bit closer
to short books describing the program.

If you have the 'help2man' program installed, then you'll also get
manual pages, albeit only ones generated automatically from the --help
output so they aren't really as good as proper hand-written manual
pages.

-- 
Colin Watson                                       [cjwatson@ubuntu.com]