Bug 284649 – we will need to document how to install with speech or braille

• Product: [OLD] Docs on www.gentoo.org
• Status: RESOLVED LATER

[Description William Hubbs 2009-09-11 22:30:44 UTC]

All,

once everything is working, we will need to document in the x86 and amd64 handbooks how to install gentoo using speech or braille.

Also, we will need to explain which packages need to be installed on the actual system so that they will have speech after the final reboot into the newly installed system.

Should I write an explanation here in the bug or generate a patch for the handbooks and attach it?

[Comment 1 nm (RETIRED) 2009-09-12 00:49:17 UTC]

Yay, we're finally getting speech support!

William, how invasive would the patch be? Are the instructions different throughout the handbook, or is it something we would just mention at the beginning the way we do with SSH: "If you want to install Gentoo, then start sshd and set a password as shown."

If it's the latter, then we can put it in the handbooks.

If it's the former, rather than rewrite (re-re-rewrite!) the handbooks to fit it in, how about splitting it out into a separate document?

[Comment 2 William Hubbs 2009-09-12 18:51:45 UTC]

Well, I see it as two pieces.

First, you will have to mention it in the section about booting the live
cd.  On the minimal cds for x86 and amd64, you will find the description
of the boot parameters in README.txt and f6.msg.

The second part of it will involve making sure that the installed system
has speech. after the final reboot.  To do that, a user will have to  do
one of two things after the kernel is compiled and installed in the
chroot:

1) if they want to use hardware speech, they will need to emerge speakup
and configure the correct module to load on reboot.

2) If they want to use software speech, they will need to do several
things:

- setup an audio system (alsa, oss, etc).
- emerge espeakup.
- make sure espeakup is set to start on boot (I haven't tested by
  putting it in the boot run level, but I know it works in default).
  - configure speakup to load the speakup_soft module on boot.

This gives speech access to the console.  Gnome is an entirely different
thing which I haven't tackled yet.

[Comment 3 William Hubbs 2009-09-19 20:13:21 UTC]

Docs team,

I haven't seen any updates on this, so I'm not sure what is going on.
What do you think about how we should document this?

[Comment 4 nm (RETIRED) 2009-09-20 05:58:40 UTC]

(In reply to comment #2)
> Well, I see it as two pieces.
> 
> First, you will have to mention it in the section about booting the live
> cd.  On the minimal cds for x86 and amd64, you will find the description
> of the boot parameters in README.txt and f6.msg.
> 
> The second part of it will involve making sure that the installed system
> has speech. after the final reboot.  To do that, a user will have to  do
> one of two things after the kernel is compiled and installed in the
> chroot:
> 
> 1) if they want to use hardware speech, they will need to emerge speakup
> and configure the correct module to load on reboot.
> 
> 2) If they want to use software speech, they will need to do several
> things:
> 
> - setup an audio system (alsa, oss, etc).
> - emerge espeakup.
> - make sure espeakup is set to start on boot (I haven't tested by
>   putting it in the boot run level, but I know it works in default).
>   - configure speakup to load the speakup_soft module on boot.
> 
> This gives speech access to the console.  Gnome is an entirely different
> thing which I haven't tackled yet.
> 

I like doing it this way: with a minimal bit at the beginning and another minimal bit at the end, in the final steps. A patch for this would be most welcome.

[Comment 5 nm (RETIRED) 2010-05-14 22:44:50 UTC]

Please reopen when the speech/braille packages required are in the installation media, and when you have a patch or suggested text for us to XMLify. Thanks!