aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2024-06-01 12:53:03 +0200
committerMattias Andrée <maandree@kth.se>2024-06-01 12:53:03 +0200
commit3ca6b74d2288bf18fc8700c91549f7127fa2d5b9 (patch)
tree6a6ef2f1ac2191d8d42d46aa3d692170600c339b /README
parentFirst commit (diff)
downloadalsause-3ca6b74d2288bf18fc8700c91549f7127fa2d5b9.tar.gz
alsause-3ca6b74d2288bf18fc8700c91549f7127fa2d5b9.tar.bz2
alsause-3ca6b74d2288bf18fc8700c91549f7127fa2d5b9.tar.xz
Add README1.0
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'README')
-rw-r--r--README58
1 files changed, 58 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..82c6ff3
--- /dev/null
+++ b/README
@@ -0,0 +1,58 @@
+NAME
+ alsause - Set default ALSA PCM device
+
+SYNPOSIS
+ alsause [(-r | name | card:device) [command [argument] ...]]
+
+DESCRIPTION
+ The alsause utility lists all ALSA PCM devices or sets, either for the
+ user or for a program it starts, the default ALSA PCM de vice.
+
+ No options or operands are specified, alsause will list all ALSA PCM
+ devices, otherwise it will set the default ALSA PCM device.
+
+ If command is specified, alsause will run that command with the default
+ ALSA PCM device set only for that process and it's child processes.
+
+OPTIONS
+ The alsause utility conforms to the Base Definitions volume of
+ POSIX.1-2017, Section 12.2, Utility Syntax Guidelines.
+
+ The following option is supported:
+
+ -r Remove the user-specified default ALSA PCM device, falling back
+ to the system-wide default ALSA PCM device.
+
+OPERANDS
+ The following operands shall be supported:
+
+ card:device
+ The card number and device number to use as the default ALSA PCM
+ device.
+
+ name
+ The card and device, by name, to use as the default ALSA PCM
+ device. This string is on the form output by the alsause
+ utility itself: "%s - %s", <card name>, <device name>.
+
+ command
+ The name of the utility to be invoked.
+
+ argument
+ A string to pass as an argument for the invoked utility.
+
+EXIT STATUS
+ If command is invoked, the exit status of alsause is the exit status of
+ command; otherwise, the alsause utility exits with one of the following
+ values.
+
+ 0 The alsause utility completed successfully.
+
+ 125 An error occurred in the alsause utility.
+
+ 126 The utility specified by command was found but could not be invoked.
+
+ 127 The utility specified by command could not be found.
+
+SEE ALSO
+ None.