README.md -> cdplayer.1
This commit is contained in:
66
cdplayer.1
Normal file
66
cdplayer.1
Normal file
@@ -0,0 +1,66 @@
|
||||
.TH CDPLAYER 1 "October 2025" "cdplayer 1.0" "User Commands"
|
||||
.SH NAME
|
||||
cdplayer \- A minimal CDDA (Compact Disc Digital Audio) player for Linux.
|
||||
.SH SYNOPSIS
|
||||
.B cdplayer
|
||||
.I cdrom
|
||||
[\fBcard=\fIN\fR] [\fBdevice=\fIN\fR]
|
||||
.SH DESCRIPTION
|
||||
.B cdplayer
|
||||
is a lightweight command-line program to play audio CDs using the ALSA sound system.
|
||||
|
||||
It reads raw audio from a CD-ROM device (such as
|
||||
.I /dev/sr0
|
||||
) and outputs sound through the specified ALSA card and PCM device.
|
||||
|
||||
By default,
|
||||
.B cdplayer
|
||||
uses ALSA card 0 and PCM device 0.
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
.I cdrom
|
||||
CD-ROM device file, e.g.
|
||||
.I /dev/sr0
|
||||
.TP
|
||||
.B card=\fIN\fR
|
||||
ALSA sound card number. Defaults to 0.
|
||||
.TP
|
||||
.B device=\fIN\fR
|
||||
ALSA PCM device number. Defaults to 0.
|
||||
.SH SIGNALS
|
||||
Playback can be controlled by sending signals to the
|
||||
.B cdplayer
|
||||
process:
|
||||
.TP
|
||||
.B SIGUSR1
|
||||
Seek forward 1 minute.
|
||||
.TP
|
||||
.B SIGUSR2
|
||||
Seek backward 1 minute.
|
||||
.TP
|
||||
.B SIGSTOP
|
||||
Pause playback.
|
||||
.TP
|
||||
.B SIGCONT
|
||||
Resume playback.
|
||||
.SH EXAMPLES
|
||||
Play a CD from the first drive on the default sound card:
|
||||
.RS
|
||||
.nf
|
||||
cdplayer /dev/sr0
|
||||
.fi
|
||||
.RE
|
||||
|
||||
Play a CD using ALSA card 1, device 0:
|
||||
.RS
|
||||
.nf
|
||||
cdplayer /dev/sr1 card=1 device=0
|
||||
.fi
|
||||
.RE
|
||||
.SH LICENSE
|
||||
0BSD \- Zero Clause BSD License.
|
||||
.SH AUTHOR
|
||||
Written by
|
||||
.MT ppedroediaz@gmail.com
|
||||
Pedro E. Díaz
|
||||
.ME
|
||||
Reference in New Issue
Block a user