alsa-utils/alsamixer/alsamixer.1
braph 2b9bfacca7 Added configuration information to manual page
Added sections FILES and CONFIGURATION.
Removed section BUGS, because the described terminal issues have been fixed.

Signed-off-by: braph <braph93@gmx.de>
Signed-off-by: Jaroslav Kysela <perex@perex.cz>
2021-08-23 16:50:47 +02:00

392 lines
10 KiB
Groff

.TH ALSAMIXER 1 "22 May 2009"
.SH NAME
alsamixer \- soundcard mixer for ALSA soundcard driver, with ncurses interface
.SH SYNOPSIS
\fBalsamixer\fP [\fIoptions\fP]
.SH DESCRIPTION
\fBalsamixer\fP is an ncurses mixer program for use with the ALSA
soundcard drivers. It supports multiple soundcards with multiple devices.
.SH OPTIONS
.TP
\fI\-h, \-\-help\fP
Help: show available flags.
.TP
\fI\-c, \-\-card\fP <card number or identification>
Select the soundcard to use, if you have more than one. Cards are
numbered from 0 (the default).
.TP
\fI\-D, \-\-device\fP <device identification>
Select the mixer device to control.
.TP
\fI\-V, \-\-view\fP <mode>
Select the starting view mode, either \fIplayback\fP, \fIcapture\fP or \fIall\fP.
.TP
\fI\-g, \-\-no\-color\fP
Toggle the using of colors.
.SH MIXER VIEWS
The top-left corner of \fBalsamixer\fP shows some basic
information: the card name, the mixer chip name, the current view
mode and the currently selected mixer item.
When the mixer item is switched off, \fI[Off]\fP is displayed in its
name.
Volume bars are located below the basic information area. You can
scroll left/right when all controls can't be put in a single screen.
The name of each control is shown in the bottom below the volume bars.
The currently selected item is drawn in red and/of emphasized.
Each mixer control with volume capability shows a box and the current
volume filled in that box. The volume percentages are displayed below
the volume bar for left and right channels. For a mono control, only
one value is shown there.
When a mixer control is turned off, \fIM\fP (mute) appears below the
volume bar. When it's turned on, \fIO\fP in green appears instead.
You can toggle the switch via \fIm\fP key.
When a mixer control has capture capability, the capture flag appears
below the volume bar, too. When the capture is turned off,
\-\-\-\-\-\-\- is shown. \fICAPTURE\fP in red appears when the
capture switch is turned on. In addition, \fIL\fP and \fIR\fP letters
appear in left and right side to indicate that left and the right
channels are turned on.
Some controls have the enumeration list, and don't show boxes but only
texts which indicate the currently active item. You can change the
item via up/down keys.
.SH VIEW MODES
\fBalsamixer\fP has three view modes: playback, capture and all.
In the playback view, only the controls related with playback are shown.
Similarly, only the controls for capture (recording) are shown in the capture
view. The all view mode shows all controls. The current view mode is displayed
in the top-left position together with the mixer name, etc.
The default view mode is the playback view. You can change it via
\fI-V\fP option.
Each view mode can be switched via keyboard commands, too.
See the next section.
.SH KEYBOARD COMMANDS
\fBalsamixer\fP recognizes the following keyboard commands to control the soundcard.
Commands shown here in upper case can also be given in lower case.
To be reminded of these keystrokes, hit the \fIh\fP key.
.SS
General Controls
The \fILeft\fP and \fIright arrow\fP keys are used to select the
channel (or device, depending on your preferred terminology). You can
also use \fIn\fP ("next") and \fIp\fP ("previous").
The \fIUp\fP and \fIDown Arrows\fP control the volume for the
currently selected device. You can also use \fI+\fP or \fI\-\fP for the
same purpose. Both the left and right signals are affected. For
independent left and right control, see below.
The \fIB\fP or \fI=\fP key adjusts the balance of volumes on left and
right channels.
\fIM\fP toggles muting for the current channel (both left and right).
If the hardware supports it, you can
mute left and right independently by using \fI,\fP (or \fI<\fP) and
\fI.\fP (or \fI>\fP) respectively.
\fISPACE\fP enables recording for the current channel. If any other
channels have recording enabled, they will have their recording function
disabled first. This only works for valid input channels, of course.
\fIL\fP re-draws the screen.
.SS
View Mode Controls
Function keys are used to change view modes.
You can switch to the help mode and the proc info mode via \fIF1\fP and
\fIF2\fP keys, respectively.
On terminals that can't use function keys like gnome\-terminal, \fI?\fP and
\fI/\fP keys can be used alternatively for help and proc modes.
\fIF3\fP, \fIF4\fP and \fIF5\fP keys are used to switch to playback, capture
and all view mode, respectively. \fITAB\fP key toggles the
current view mode circularly.
.SS
Quick Volume Changes
\fIPageUp\fP increases volume by 5.
\fIPageDown\fP decreases volume by 5.
\fIEnd\fP sets volume to 0.
You can also control left & right levels for the current channel
independently, as follows:
[\fIQ\fP | \fIW\fP | \fIE\fP ] -- turn UP [ left | both | right ]
[\fIZ\fP | \fIX\fP | \fIC\fP ] -- turn DOWN [ left | both | right ]
If the currently selected mixer channel is not a stereo channel, then
all UP keys will work like \fIW\fP, and all DOWN keys will work like \fIX\fP.
The number keys from \fI0\fP to \fI9\fP are to change the absolute volume
quickly. They correspond to 0 to 90% volume.
.SS
Selecting the Sound Card
You can select another sound card by pressing the \fIF6\fP or \fIS\fP keys.
This will show a list of available sound cards to choose from,
and an entry to enter the mixer device name by hand.
.SS
Exiting
Quit the program with \fIALT Q\fP, or by hitting \fIESC\fP.
Please note that you might need to hit \fIESC\fP twice on some terminals
since it's regarded as a prefix key.
.SH VOLUME MAPPING
In \fBalsamixer\fP, the volume is mapped to a value that is more natural
for a human ear. The mapping is designed so that the position in the
interval is proportional to the volume as a human ear would perceive
it, i.e. the position is the cubic root of the linear sample
multiplication factor. For controls with a small range (24 dB or
less), the mapping is linear in the dB values so that each step has
the same size visually.
Only for controls without dB information, a linear mapping of the
hardware volume register values is used (this is the same algorithm as
used in the old \fBalsamixer\fP).
.SH FILES
Configuration is read from the following files:
\fI$XDG_CONFIG_HOME\fP/alsamixer.rc
\fI$HOME\fP/.config/alsamixer.rc
.SH CONFIGURATION
Comments start with '#'.
.TP
\fBcolor\fP \fIelement\fP \fIforeground\fP \fIbackground\fP [\fIattribute...\fP]
Valid values for \fIforeground\fP and \fIbackground\fP are: red, green, yellow, blue, magenta, cyan, white, black, none / default.
Valid values for \fIattribute\fP are: bold, normal, reverse, underline, dim, italic, blink.
See section \fBTHEME ELEMENTS\fP for a list of \fIelements\fP.
.TP
\fBset\fP \fIoption\fP \fIvalue\fP
\fBmouse_wheel_step\fP \fI<N>\fP
Set the mouse wheel step to \fI<N>\fP
\fBmouse_wheel_focuses_control\fP \fI0|1\fP
If enabled (\fI1\fP), mixer controls can be changed by hovering over them and scrolling the mouse wheel.
.TP
\fBbind\fP \fIkey_definition\fP \fIcommand\fP
A \fIkey_definition\fP may be:
- a single character
- a combination with control: C-a
- a combination with alt: M-a
- a special keyname: Enter, Escape, PageUp, PageDown, Left, Down, Right, Up, Home, End, Backspace, F1 .. F12
See section \fBCOMMANDS\fP for a list of \fIcommands\fP.
.SS COMMANDS
.TP
\fItextbox_close\fP
Close textbox
.TP
\fItextbox_up\fP / \fItextbox_down\fP
Scroll text up/down by one line
.TP
\fItextbox_left\fP / \fItextbox_right\fP
Scroll text left/right by one column
.TP
\fItextbox_page_up\fP / \fItextbox_page_down\fP
Scroll text up/down one page
.TP
\fItextbox_page_left\fP / \fItextbox_page_right\fP
Scroll text left/right one page
.TP
\fItextbox_top\fP / \fItextbox_bottom\fP
Go to top/bottom position of text
.TP
\fImixer_balance_volumes\fP
Balance both channels
.TP
\fImixer_close\fP
Close alsamixer application
.TP
\fImixer_help\fP
Show help
.TP
\fImixer_mode_playback\fP
Show playback controls
.TP
\fImixer_mode_capture\fP
Show capture controls
.TP
\fImixer_mode_all\fP
Show playback and capture controls
.TP
\fImixer_mode_toggle\fP
Toggle between playback/capture/all controls
.TP
\fImixer_refresh\fP
Refresh screen
.TP
\fImixer_previous\fP / \fImixer_next\fP
Select previous/next mixer control
.TP
\fImixer_control_focus_<N>\fP
Focus control number \fI<N>\fP.
.TP
\fImixer_control_set_<N>\fP[\fI_left\fP|\fI_right\fP]
Change volume of current control to \fI<N>\fP percent.
.TP
\fImixer_control_up_<N>\fP[\fI_left\fP|\fI_right\fP]
Increase volume of current control by \fI<N>\fP percent.
.TP
\fImixer_control_down_<N>\fP[\fI_left\fP|\fI_right\fP]
Decrease volume of current control by \fI<N>\fP percent.
.TP
\fImixer_toggle_mute\fP[\fI_left\fP|\fI_right\fP]
Toggle mute state of both/left/right channels
.TP
\fImixer_toggle_capture\fP[\fI_left\fP|\fI_right\fP]
Toggle capture state of both/left/right channels
.TP
\fImixer_select_card\fP
Show window for selecting sound card
.TP
\fImixer_system_information\fP
Show system information
.SS THEME ELEMENTS
.TP
\fImixer_frame\fP Color of the box around the mixer
.TP
\fImixer_text\fP Color of text at the top of the mixer
.TP
\fImixer_active\fP Color of \fIAlsaMixer\fP heading
.TP
\fIctl_frame\fP Color of the frame around the mixer controls
.TP
\fIctl_mute\fP Color indicating the mute state (\fIMM\fP)
.TP
\fIctl_nomute\fP Color indicating the unmute state (\fI00\fP)
.TP
\fIctl_capture\fP Color of \fICAPTURE\fP text
.TP
\fIctl_nocapture\fP Colof of disabled capture label
.TP
\fIctl_label\fP Color of label underneath mixer controls
.TP
\fIctl_label_focus\fP Color of label underneath focused mixer control
.TP
\fIctl_mark_focus\fP Color of \fI<>\fP marks beside focused mixer label
.TP
\fIctl_bar_lo\fP Color of lower volume bar
.TP
\fIctl_bar_mi\fP Color of middle volume bar
.TP
\fIctl_bar_hi\fP Color of top volume bar
.TP
\fIctl_inactive\fP Color for inactive control
.TP
\fIctl_label_inactive\fP Color for inactive label
.TP
\fIerrormsg\fP Color used for error message
.TP
\fIinfomsg\fP Color used for information message
.TP
\fItextbox\fP Color used for textbox (user input)
.TP
\fItextfield\fP Color used for textbox
.TP
\fImenu\fP Color used for menu
.TP
\fImenu_selected\fP Color used for selected entry in menu
.SH SEE ALSO
\fB
amixer(1),
aplay(1),
arecord(1)
\fP
.SH AUTHOR
.B alsamixer
has been written by Tim Janik and
been further improved by Jaroslav Kysela <perex@perex.cz>
and Clemens Ladisch <clemens@ladisch.de>.
This manual page was provided by Paul Winkler <zarmzarm@erols.com>.