Updated documentation

This commit is contained in:
Veit Heller
2014-09-15 18:03:24 +02:00
parent 3dc5b6f5e0
commit 8e94d4336a

View File

@@ -1,4 +1,23 @@
cd_check
========
cd\_check
=========
Small utilities for checking the CD tray under Linux
This repository contains small utilities for checking the CD tray
under Linux. I am sure that there are other, more capable tools out there,
but it is useful, lightweight and easy to install.
Installing
----------
After pulling, just run `make && make install`. You may need superuser
priviliges to run `make install`.
You can run the following tools afterward:
`cd_check_eject`: Checks whether ejecting a CD works
`cd_check_capabilities`: Checks which capabilities the CD tray has
`cd_check_read_toc`: Checks whether reading the "table of content" works
`cd_check_read`: Checks whether reading works. Also one of the most basic audio
players that exists.
All of those commands may require superuser privileges, as they are making use
of ìoctl()`often.