Difference between revisions of "TalkingArch"

From ArchWiki
Jump to: navigation, search
m (Correction: key ID versus key fingerprint.)
(modify for systemd + espeakup)
(29 intermediate revisions by 9 users not shown)
Line 1: Line 1:
[[Category:Getting and installing Arch (English)]]
+
[[Category:Getting and installing Arch]]
[[Category:HOWTOs (English)]]
+
[[Category:Accessibility]]
= Introduction =
+
This page describes a bootable CD / USB image customized for blind users. The modified version is mostly equivalent to the official "netinstall CD", but the system should start speaking as soon as you boot with it. Speech is provided via the sound card, using the eSpeak software synthesizer and the Speakup screenreader. It is also possible to use a braille display, via brltty. You can obtain the image [http://the-brannons.com/tarch/ from this page].
This page describes the  second release of a modified ArchLinux install CD that includes spoken output for blind users. The modified version is mostly equivalent to the official "ftp CD", but the system should start speaking as soon as you boot with it. Speech is provided via the sound card, using the eSpeak software synthesizer and the Speakup screenreader.
+
It is only available for the i686 platform; x86-64 is not supported. There are two versions: an Isolinux version and a Grub version. One may obtain ".iso" images via HTTP.
+
  
Grub:
+
The image can be used with both the i686 or the x86_64 architecture. Also, it is suitable for either a recordable CD or a USB stick. Just download it and write it to the medium of your choice.
[http://cmb.tysdomain.com/TalkingArch-2009.03-ftp-i686.iso download]
+
[http://cmb.tysdomain.com/TalkingArch-2009.03-ftp-i686.iso.sig detached signature]<br>
+
MD5 sum: e0854e63d59cea73b94ba0d5b46206d0
+
  
Isolinux:
+
A detached GPG signature is provided on the download page. The signature is made with the gpg key associated with the address '''chris at the-brannons dot com'''. The key ID is '''6521E06D'''. The fingerprint is '''66BD 74A0 36D5 22F5 1DD7 0A3C 7F2A 1672 6521 E06D'''
[http://cmb.tysdomain.com/TalkingArch-2009.03-ftp-i686-isolinux.iso download]
+
[http://cmb.tysdomain.com/TalkingArch-2009.03-ftp-i686-isolinux.iso.sig detached signature]<br>
+
MD5 sum: 23a40cb13455a8580cc04730e741d6eb
+
  
The detached signatures were made using the gpg key associated with the address
+
=== Credits ===
cmbrannon79 at gmail dot comThe key ID is CE8D2EE8.
+
The images are produced and hosted by Chris Brannon.
The fingerprint is A2C6 0177 783D 222E 3677  E247 83A0 DB7D CE8D 2EE8
+
Thanks to the following people for submitting valuable feedback regarding this project: Chuck Hallenbeck, Julien Claassen, Alastair Irving, Tyler Spivey,  Keith Hinton, and many othersThanks also go to Tyler Littlefield, who previously hosted the files.
  
This is release 3 of the ISO.  It fixes a major defect found in release 2.
+
== Installing from the CD ==
The sound card initialization script shipped with release 2 only unmuted
+
The following list of steps is a brief guide to installing Arch Linux using this CD. The instructions assume that your root partition will be mounted on {{ic|/mnt}}.
the Master and PCM controls.  This is not sufficient for all sound cards.
+
The script included in release 3 should unmute all necessary controls.
+
  
== Credits ==
+
#This is a dual-architecture .iso file.  If you're booting on an i686 machine, then you can just press {{keypress|enter}} at the boot prompt, or wait for the bootloader to time-out. If you're booting on an x86_64 system, then do this.  Wait for the boot prompt.  If you're lucky, then you have a console speaker, and you'll hear a beep when the bootloader is ready.  If you don't have a console speaker, just wait for your CD-ROM drive to stop spinning, or alternatively, wait 20 or 30 seconds when booting from USB. Once you've reached the boot prompt, press {{keypress|escape}} and type {{ic|arch64}} and press {{keypress|enter}}.
This CD was produced by Chris Brannon, and the downloadable images are hosted by Tyler Littlefield.
+
#You are strongly encouraged to read the Arch Linux documentation, especially the [[Installation Guide]] and [[Beginners Guide]].  Do the installation procedure described in the [[Installation Guide]], as modified by the instructions below.
Thanks to the following people for submitting valuable feedback regarding release 2: Chuck Hallenbeck, Julien Claassen, and Keith Hinton.
+
#You'll need to install the {{ic|espeakup}} and {{ic|alsa-utils}} packages. The [[Installation Guide]] mentions that you can install additional packages by appending their names to the packstrap command. For example, {{ic|pacstrap /mnt base espeakup alsa-utils}}
 
+
#Enable the espeakup systemd service by typing {{ic|chroot /mnt systemctl enable espeakup.service}}
= Installing from the CD =
+
#You also need to save the state of the sound card, so that it will be retrieved on reboot. Execute the command {{ic|alsactl -f /var/lib/alsa/asound.state store}} and copy the file {{ic|/var/lib/alsa/asound.state}} to {{ic|/mnt/var/lib/alsa/asound.state}}. Alternatively, {{ic|alsactl -f /mnt/var/lib/alsa/asound.state store}} will do this with one command.
The following list of steps is a brief guide to installing ArchLinux
+
using this CD.
+
The instructions assume that your root partition will be mounted on /mnt.
+
 
+
#When booting, Grub provides a very long timeout. Press enter once the drive stops spinning.
+
#Use the installer on the CD, as per the [[Beginners Guide]].
+
#Install the alsa-utils and espeak packages: <pre>pacman --root=/mnt -Sy alsa-utils espeak</pre>
+
#Install the speakup and espeakup packages. These are not yet available in the community repository. There are two ways to install them.
+
##Use the binary packages from Chris Brannon's custom package repository.
+
##:I promise that the speakup package will always match the kernel version available from the official ArchLinux repositories. Append the following two lines to <pre>/etc/pacman.conf</pre> and <pre>/mnt/etc/pacman.conf</pre>: <br>
+
##:<pre>[blind]</pre>
+
##:<pre>Server = http://members.cox.net/cmbrannon/blind/i686</pre>
+
##:Install the packages from my custom repository: <pre>pacman --root=/mnt -Sy speakup espeakup</pre>
+
##Build the packages from source, using the PKGBUILDs available from the Arch User Repository. For convenience, the URLs are: [http://aur.archlinux.org/download/speakup/speakup.tar.gz speakup PKGBUILD] [http://aur.archlinux.org/download/espeakup/espeakup.tar.gz espeakup PKGBUILD]. If I were going to choose this option, I would probably chroot into the newly installed ArchLinux system in order to build the packages.
+
#Customize <pre>/mnt/etc/rc.conf</pre>: Add speakup and speakup_soft to the MODULES array. Add alsa and espeakup to the DAEMONS array.
+
#You also need to save the state of the sound card, so that it will be retrieved on reboot. Execute the command <pre>alsactl store</pre> and copy the file <pre>/etc/asound.state</pre> to <pre>/mnt/etc/asound.state</pre>. Alternatively, <pre>alsactl -f /mnt/etc/asound.state store</pre>
+
 
#When you boot the system from the hard disk, it should start speaking.
 
#When you boot the system from the hard disk, it should start speaking.
  
== Handling Dialogs with Speakup ==
+
== Braille Support ==
The ArchLinux installer, <pre>/arch/setup</pre>, makes extensive use of the '''dialog''' program. Users may experience some difficulties when navigating several of the menus and dialogsThis is not specific to ArchLinux.  Other text-mode installers often have similar problems.
+
The latest image includes brltty, for those who own braille displays.  The brltty package available on the CD was compiled with as few dependencies as possible. It is packaged as brltty-minimal in the Arch User Repository.  If you wish to use braille, you will need to supply the brltty parameter at the boot promptAlternatively, you can start brltty from the shell, after the system has booted.
 
+
The following discussion was compiled from suggestions on the Speakup list,
+
and it includes some advice from Chris Brannon.
+
 
+
First, enable highlight tracking.  Press the star key on the numeric keypad.
+
If you use a laptop that lacks the numeric keypad, press the sequence
+
capslock control 8.
+
Speakup will say "highlight tracking".  This is sufficient to navigate
+
most of the menus with the arrow keys, but there are a few notable exceptions, described in the following paragraphs.
+
 
+
=== Choosing a Filesystem ===
+
The "choose filesystem" menu doesn't cooperate with highlight tracking.
+
It is difficult to determine which of the entries is selected.
+
There are two solutions.
+
The first is suggested by Adam Myrow.
+
 
+
<blockquote>
+
You can also use insert+period on the numeric keypad to check out the
+
color of the text under the cursor.  By going from line to line, and
+
checking the color, it should become apparent which item is selected.  For
+
example, in Slackware, the highlighted option is bright red on blue, and
+
the others are red on cyan.  In this example, highlight tracking gives
+
improper feedback, listing the option above the one that is selected.
+
</blockquote>
+
 
+
Note for laptop users: the equivalent key sequence is capslock slash.
+
 
+
The second solution is even easier, assuming that you want ext2, ext3, or ext4
+
as your filesystem.  If you want ext2, just press enter after the menu
+
is displayed.  If you want ext3, press down-arrow once, followed by enter.
+
Two down-arrows from the top of the menu gives you ext4.
+
This is Chris Brannon's preferred method.  Just count menu entries, and
+
press down-arrow the requisite number of times.
+
 
+
=== Setting the Date and Time ===
+
The "set timezone" menus are a joy to navigate, because the entries
+
are numbered.  Just type the corresponding number and press enter.
+
 
+
The "set date and time" menus are problematicIgnore them, because there
+
is a better way to set your system's clock.  Once you have booted ArchLinux
+
from the hard drive, install the ntp package.  Next, execute the command
+
<pre>ntpdate rolex.usg.edu</pre>
+
You need to be logged in as root to perform both steps.
+
Your system's clock will be synchronized with a time server located in
+
the US state of Georgia.
+
You may wish to find a time server that is closer to you.  Chris Brannon never
+
manually sets a system's clock, since setting it with NTP is so much easier.
+
 
+
= Maintaining Your Speech-enabled ArchLinux Installation =
+
If you added my custom package repository to your pacman.conf file,
+
then you will be able to receive upgrades to the speakup and espeakup packages
+
whenever they happen.  This is infrequent.
+
I rebuild speakup whenever ArchLinux provides a major kernel upgrade.
+
When kernel version 2.6.28 replaced version 2.6.27, a new speakup package
+
was available several hours after the new kernel was made available on
+
the Arch mirrors.
+
Everything should seamlessly work.
+
  
= Mastering Speech-enabled ISO Images =
+
The brltty boot-time parameter consists of three comma-separated fields: driver, device, and table. The first is the driver for your display, the second is the name of the device file, and the third is a relative path to a translation table.  You can use "auto" to specify that the driver should be automatically detected. I encourage you to read the brltty documentation for a fuller explanation of the program.
The ArchLinux developers build their CD images using a set of shell scripts and configuration files named archiso. I added a configuration to archiso that allows me to build accessible CDs. If someone wants to produce customized images containing Speakup, he can do the following.
+
  
Grab sources using git:
+
For example, suppose that you have a device connected to /dev/ttyS0, the first serial port. You wish to use the US English text table, and the driver should be automatically detected. Here is what you should type at the boot prompt:
<pre>
+
arch32 brltty=auto,ttyS0,en_US
git clone http://members.cox.net/cmbrannon/archiso.git
+
cd archiso
+
git checkout --track -b talkinginst origin/talkinginst
+
</pre>
+
  
All of my work is done on the "talkinginst" branch. The master branch
+
Once brltty is running, you may wish to disable speech.  You can do so via the "print screen" key, also known as sysrq. On my qwerty keyboard, that key is located directly above the insert key, between F12 and scroll lock.
mirrors the master branch from <pre>git://projects.archlinux.org/archiso.git</pre>
+
  
Install the scripts contained in the archiso/ subdirectory of the sources.
+
== Maintaining Your Speech-enabled Arch Linux Installation ==
 +
You shouldn't need to do anything extraordinary to maintain the installation. Everything should just seamlessly work.
  
In order to create the image, pacman needs to be able to find the speakup
+
== Mastering Speech-enabled ISO Images ==
and espeakup packages.
+
This process is now fairly straightforward.  Just grab and install the talkingarch-git package from the AUR. It depends on archiso-git, so you need that as well. See /usr/share/doc/talkingarch/README for full instructions.
Add my custom "blind" package repository to <pre>/etc/pacman.conf</pre> on the host system, as described in the instructions for installing from CD. Change to the configs/talkinginst directory, and type <pre>make ftp-iso</pre>.
+
  
Alternatively,
+
== Further Resources ==
<pre>
+
make BOOTLOADER=syslinux ftp-iso
+
</pre>
+
yields an image having Isolinux as its bootloader. There are several more targets for "make". For instance, ftp-usb produces an image suitable for a flash drive.
+
  
= Additional Notes =
+
Michael Whapples made an audio tutorial demonstrating the process of installing ArchLinux using this CD.  Click [ftp://linux-speakup.org/pub/speakup/audio/blind_archlinux.mp3 here] to listen to it!  Note that it is out of date, as of the 2012.07.23 snapshot.
Presently, this CD is only usable with English-language speech.
+
  
= Disclaimer =
+
== Disclaimer ==
The author of this modified CD is in no way associated with ArchLinux. The product is not an official release.  It is not endorsed by anyone other than Chris Brannon.  It is provided solely for the convenience of its creator and other blind users, and it comes with absolutely no warranty.
+
This is not an official release.  It is not endorsed by anyone other than Chris Brannon.  It is provided solely for the convenience of its creator and other blind users, and it comes with absolutely no warranty.
 +
<!-- vim: set ft=Wikipedia: -->

Revision as of 03:39, 26 November 2012

This page describes a bootable CD / USB image customized for blind users. The modified version is mostly equivalent to the official "netinstall CD", but the system should start speaking as soon as you boot with it. Speech is provided via the sound card, using the eSpeak software synthesizer and the Speakup screenreader. It is also possible to use a braille display, via brltty. You can obtain the image from this page.

The image can be used with both the i686 or the x86_64 architecture. Also, it is suitable for either a recordable CD or a USB stick. Just download it and write it to the medium of your choice.

A detached GPG signature is provided on the download page. The signature is made with the gpg key associated with the address chris at the-brannons dot com. The key ID is 6521E06D. The fingerprint is 66BD 74A0 36D5 22F5 1DD7 0A3C 7F2A 1672 6521 E06D

Credits

The images are produced and hosted by Chris Brannon. Thanks to the following people for submitting valuable feedback regarding this project: Chuck Hallenbeck, Julien Claassen, Alastair Irving, Tyler Spivey, Keith Hinton, and many others. Thanks also go to Tyler Littlefield, who previously hosted the files.

Installing from the CD

The following list of steps is a brief guide to installing Arch Linux using this CD. The instructions assume that your root partition will be mounted on /mnt.

  1. This is a dual-architecture .iso file. If you're booting on an i686 machine, then you can just press Template:Keypress at the boot prompt, or wait for the bootloader to time-out. If you're booting on an x86_64 system, then do this. Wait for the boot prompt. If you're lucky, then you have a console speaker, and you'll hear a beep when the bootloader is ready. If you don't have a console speaker, just wait for your CD-ROM drive to stop spinning, or alternatively, wait 20 or 30 seconds when booting from USB. Once you've reached the boot prompt, press Template:Keypress and type arch64 and press Template:Keypress.
  2. You are strongly encouraged to read the Arch Linux documentation, especially the Installation Guide and Beginners Guide. Do the installation procedure described in the Installation Guide, as modified by the instructions below.
  3. You'll need to install the espeakup and alsa-utils packages. The Installation Guide mentions that you can install additional packages by appending their names to the packstrap command. For example, pacstrap /mnt base espeakup alsa-utils
  4. Enable the espeakup systemd service by typing chroot /mnt systemctl enable espeakup.service
  5. You also need to save the state of the sound card, so that it will be retrieved on reboot. Execute the command alsactl -f /var/lib/alsa/asound.state store and copy the file /var/lib/alsa/asound.state to /mnt/var/lib/alsa/asound.state. Alternatively, alsactl -f /mnt/var/lib/alsa/asound.state store will do this with one command.
  6. When you boot the system from the hard disk, it should start speaking.

Braille Support

The latest image includes brltty, for those who own braille displays. The brltty package available on the CD was compiled with as few dependencies as possible. It is packaged as brltty-minimal in the Arch User Repository. If you wish to use braille, you will need to supply the brltty parameter at the boot prompt. Alternatively, you can start brltty from the shell, after the system has booted.

The brltty boot-time parameter consists of three comma-separated fields: driver, device, and table. The first is the driver for your display, the second is the name of the device file, and the third is a relative path to a translation table. You can use "auto" to specify that the driver should be automatically detected. I encourage you to read the brltty documentation for a fuller explanation of the program.

For example, suppose that you have a device connected to /dev/ttyS0, the first serial port. You wish to use the US English text table, and the driver should be automatically detected. Here is what you should type at the boot prompt:

arch32 brltty=auto,ttyS0,en_US

Once brltty is running, you may wish to disable speech. You can do so via the "print screen" key, also known as sysrq. On my qwerty keyboard, that key is located directly above the insert key, between F12 and scroll lock.

Maintaining Your Speech-enabled Arch Linux Installation

You shouldn't need to do anything extraordinary to maintain the installation. Everything should just seamlessly work.

Mastering Speech-enabled ISO Images

This process is now fairly straightforward. Just grab and install the talkingarch-git package from the AUR. It depends on archiso-git, so you need that as well. See /usr/share/doc/talkingarch/README for full instructions.

Further Resources

Michael Whapples made an audio tutorial demonstrating the process of installing ArchLinux using this CD. Click here to listen to it! Note that it is out of date, as of the 2012.07.23 snapshot.

Disclaimer

This is not an official release. It is not endorsed by anyone other than Chris Brannon. It is provided solely for the convenience of its creator and other blind users, and it comes with absolutely no warranty.