Blame alsactl/alsactl.1

Packit 229ac0
.TH ALSACTL 1 "07 May 2014"
Packit 229ac0
.SH NAME
Packit 229ac0
alsactl \- advanced controls for ALSA soundcard driver
Packit 229ac0
Packit 229ac0
.SH SYNOPSIS
Packit 229ac0
Packit 229ac0
\fBalsactl\fP [\fIoptions\fP] [\fIstore\fP|\fIrestore\fP|\fIinit\fP] <card # or id or device>
Packit 229ac0
Packit 229ac0
\fBalsactl\fP \fImonitor\fP <card # or id>
Packit 229ac0
Packit 229ac0
.SH DESCRIPTION
Packit 229ac0
\fBalsactl\fP is used to control advanced settings for the ALSA
Packit 229ac0
soundcard drivers. It supports multiple soundcards. If your card has
Packit 229ac0
features that you can't seem to control from a mixer application,
Packit 229ac0
you have come to the right place.
Packit 229ac0
Packit 229ac0
.SH COMMANDS
Packit 229ac0
Packit 229ac0
\fIstore\fP saves the current driver state for the selected soundcard
Packit 229ac0
to the configuration file.
Packit 229ac0
Packit 229ac0
\fIrestore\fP loads driver state for the selected soundcard from the
Packit 229ac0
configuration file. If restoring fails (eventually partly), the init
Packit 229ac0
action is called.
Packit 229ac0
Packit 229ac0
\fInrestore\fP is like \fIrestore\fP, but it notifies also the daemon
Packit 229ac0
to do new rescan for available soundcards.
Packit 229ac0
Packit 229ac0
\fIinit\fP tries to initialize all devices to a default state. If device
Packit 229ac0
is not known, error code 99 is returned.
Packit 229ac0
Packit 229ac0
\fIdaemon\fP manages to save periodically the sound state.
Packit 229ac0
Packit 229ac0
\fIrdaemon\fP like \fIdaemon\fP but restore the sound state at first.
Packit 229ac0
Packit 229ac0
\fIkill\fP notifies the daemon to do the specified operation (quit,
Packit 229ac0
rescan, save_and_quit).
Packit 229ac0
Packit 229ac0
\fImonitor\fP is for monitoring the events received from the given
Packit 229ac0
control device.
Packit 229ac0
Packit 229ac0
If no soundcards are specified, setup for all cards will be saved,
Packit 229ac0
loaded or monitored.
Packit 229ac0
Packit 229ac0
.SH OPTIONS
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
\fI\-h, \-\-help\fP 
Packit 229ac0
Help: show available flags and commands.
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
\fI\-d, \-\-debug\fP
Packit 229ac0
Use debug mode: a bit more verbose.
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
\fI\-v, \-\-version\fP
Packit 229ac0
Print alsactl version number.
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
\fI\-f, \-\-file\fP
Packit 229ac0
Select the configuration file to use. The default is /var/lib/alsa/asound.state.
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
\fI\-l, \-\-lock\fP
Packit 229ac0
Use the file locking to serialize the concurrent access to the state file (this
Packit 229ac0
option is default for the global state file).
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
\fI\-L, \-\-no-lock\fP
Packit 229ac0
Do not use the file locking to serialize the concurrent access to the state
Packit 229ac0
file (including the global state file).
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
\fI\-O, \-\-lock-state-file\fP
Packit 229ac0
Select the state lock file path.
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
\fI\-F, \-\-force\fP
Packit 229ac0
Used with restore command.  Try to restore the matching control elements
Packit 229ac0
as much as possible.  This option is set as default now.
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
\fI\-g, \-\-ignore\fP
Packit 229ac0
Used with store and restore commands. Do not show 'No soundcards found'
Packit 229ac0
and do not set an error exit code when soundcards are not installed.
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
\fI\-P, \-\-pedantic\fP
Packit 229ac0
Used with restore command.  Don't restore mismatching control elements.
Packit 229ac0
This option was the old default behavior.
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
\fI\-I, \-\-no\-init\-fallback\fP
Packit 229ac0
Don't initialize cards if restore fails.  Since version 1.0.18,
Packit 229ac0
\fBalsactl\fP tries to initialize the card with the restore operation
Packit 229ac0
as default.  But this can cause incompatibility with the older version.
Packit 229ac0
The caller may expect that the state won't be touched if no state file
Packit 229ac0
exists.  This option takes the restore behavior back to the older
Packit 229ac0
version by suppressing the initialization.
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
\fI\-r, \-\-runstate\fP
Packit 229ac0
Save restore and init state to this file. The file will contain only errors.
Packit 229ac0
Errors are appended with the soundcard id to the end of file.
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
\fI\-R, \-\-remove\fP
Packit 229ac0
Remove runstate file at first.
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
\fI\-E, \-\-env\fP #=#
Packit 229ac0
Set environment variable (useful for init action or you may override
Packit 229ac0
ALSA_CONFIG_PATH to read different or optimized configuration - may be
Packit 229ac0
useful for "boot" scripts).
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
\fI\-i, \-\-initfile\fP
Packit 229ac0
The configuration file for init. By default, PREFIX/share/alsa/init/00main
Packit 229ac0
is used.
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
\fI\-p, \-\-period\fP
Packit 229ac0
The store period in seconds for the daemon command.
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
\fI\-e, \-\-pid-file\fP
Packit 229ac0
The pathname to store the process-id file in the HDB UUCP format (ASCII).
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
\fI\-b, \-\-background\fP
Packit 229ac0
Run the task in background.
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
\fI\-s, \-\-syslog\fP
Packit 229ac0
Use syslog for messages.
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
\fI\-n, \-\-nice\fP
Packit 229ac0
Set the process priority (see 'man nice')
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
\fI\-c, \-\-sched-idle\fP
Packit 229ac0
Set the process scheduling policy to idle (SCHED_IDLE).
Packit 229ac0
Packit 229ac0
.SH FILES
Packit 229ac0
\fI/var/lib/alsa/asound.state\fP (or whatever file you specify with the
Packit 229ac0
\fB\-f\fP flag) is used to store current settings for your
Packit 229ac0
soundcards. The settings include all the usual soundcard mixer
Packit 229ac0
settings.  More importantly, alsactl is
Packit 229ac0
capable of controlling other card-specific features that mixer apps
Packit 229ac0
usually don't know about.
Packit 229ac0
Packit 229ac0
The configuration file is generated automatically by running
Packit 229ac0
\fBalsactl store\fP. Editing the configuration file by hand may be
Packit 229ac0
necessary for some soundcard features (e.g. enabling/disabling
Packit 229ac0
automatic mic gain, digital output, joystick/game ports, some future MIDI
Packit 229ac0
routing options, etc).
Packit 229ac0
Packit 229ac0
.SH SEE ALSO
Packit 229ac0
\fB
Packit 229ac0
amixer(1),
Packit 229ac0
alsamixer(1),
Packit 229ac0
aplay(1),
Packit 229ac0
alsactl_init(7)
Packit 229ac0
\fP
Packit 229ac0
Packit 229ac0
.SH BUGS 
Packit 229ac0
None known.
Packit 229ac0
Packit 229ac0
.SH AUTHOR
Packit 229ac0
\fBalsactl\fP is by Jaroslav Kysela <perex@perex.cz> and Abramo Bagnara
Packit 229ac0
<abramo@alsa\-project.org>. This document is by Paul Winkler <zarmzarm@erols.com>.