alsa-info.sh: add man page

diff --git a/alsa-info/Makefile.am b/alsa-info/Makefile.am
index 356f1a9ae94b7528ad217eeeab91c15a3030d980..c786361dc68cdd1258a858791f1c05cf2829b706 100644 (file)
--- a/alsa-info/Makefile.am
+++ b/alsa-info/Makefile.am
@@ -1,2 +1,3 @@
 EXTRA_DIST = alsa-info.sh
 sbin_SCRIPTS = alsa-info.sh
+man_MANS = alsa-info.sh.1

diff --git a/alsa-info/alsa-info.sh.1 b/alsa-info/alsa-info.sh.1
new file mode 100644 (file)
index 0000000..7168b3e
--- /dev/null
+++ b/alsa-info/alsa-info.sh.1
@@ -0,0 +1,62 @@
+.TH ALSA-INFO.SH 1 "13 January 2016"
+.SH NAME
+alsa-info.sh \- command\-line utility to gather information about
+the ALSA subsystem
+.SH SYNOPSIS
+\fBalsa-info.sh\fP [\fIoptions\fP]
+
+.SH DESCRIPTION
+\fBalsa-info.sh\fP is a command\-line utility gathering information
+about the ALSA subsystem. It is used mostly for debugging purposes.
+
+.SH OPTIONS
+.TP
+\fI\-\-upload\fP
+Upload contents to the server (www.alsa-project.org or pastebin.ca).
+.TP
+\fI\-\-no-upload\fP
+Do not upload contents to the remote server.
+.TP
+\fI\-\-stdout\fP
+Print information to standard output.
+.TP
+\fI\-\-output FILE\fP
+Specify file for output in no-upload mode.
+.TP
+\fI\-\-debug\fP
+Run utility as normal, but will not delete file (usually
+/tmp/alsa-info.txt).
+.TP
+\fI\-\-with-aplay\fP
+Includes output from \fIaplay -l\fP.
+.TP
+\fI\-\-with-amixer\fP
+Includes output from \fIamixer\fP.
+.TP
+\fI\-\-with-alsactl\fP
+Includes output from \fIalsactl\fP.
+.TP
+\fI\-\-with-configs\fP
+Includes output from ~/.asoundrc and /etc/asound.conf if they exist.
+.TP
+\fI\-\-update\fP
+Check server for updates.
+.TP
+\fI\-\-about\fP
+Print information about authors.
+
+.SH EXAMPLES
+
+.TP
+\fBalsa-info.sh \-\-no-upload\fR
+Will gather all information and show the output file.
+
+.SH SEE ALSO
+\fB
+aplay(1)
+amixer(1)
+alsactl(1)
+\fP
+
+.SH AUTHOR
+\fBalsa-info.sh\fP was created by the ALSA team, see \fI\-\-about\fP .