Gentoo Development Guide

CDROM.ECLASS

Section: portage (5)
Updated: May 2013
Index Return to Main Contents

NAME

cdrom.eclass - Functions for CD-ROM handling

DESCRIPTION

Acquire cd(s) for those lovely cd-based emerges. Yes, this violates the whole 'non-interactive' policy, but damnit I want CD support!

With these cdrom functions we handle all the user interaction and standardize everything. All you have to do is call cdrom_get_cds() and when the function returns, you can assume that the cd has been found at CDROM_ROOT.

FUNCTIONS

cdrom_get_cds <file on cd1> [file on cd2] [file on cd3] [...]

The function will attempt to locate a cd based upon a file that is on the cd. The more files you give this function, the more cds the cdrom functions will handle.

Normally the cdrom functions will refer to the cds as 'cd #1', 'cd #2', etc... If you want to give the cds better names, then just export the appropriate CDROM_NAME variable before calling cdrom_get_cds(). Use CDROM_NAME for one cd, or CDROM_NAME_# for multiple cds. You can also use the CDROM_NAME_SET bash array.

For those multi cd ebuilds, see the cdrom_load_next_cd() function.

cdrom_load_next_cd

Some packages are so big they come on multiple CDs. When you're done reading files off a CD and want access to the next one, just call this function. Again, all the messy details of user interaction are taken care of for you. Once this returns, just read the variable CDROM_ROOT for the location of the mounted CD. Note that you can only go forward in the CD list, so make sure you only call this function when you're done using the current CD.

ECLASS VARIABLES

CDROM_OPTIONAL: By default, the eclass sets PROPERTIES="interactive" on the assumption that people will be using these. If your package optionally supports disc based installed, then set this to "yes", and we'll set things conditionally based on USE=cdinstall.

MAINTAINERS

games@gentoo.org

REPORTING BUGS

Please report bugs via http://bugs.gentoo.org/

FILES

/usr/portage/eclass/cdrom.eclass

This document was created by man2html, using the manual pages.
Time: 03:25:01 GMT, May 23, 2013