mirror of
https://github.com/clearlinux/mixer-tools.git
synced 2026-09-03 20:21:32 +00:00
Matthew Johnson
8e93fa21e6
Add manual pages for the top-level mixer command and all subcommands. Signed-off-by: Matthew Johnson <matthew.johnson@intel.com>
103 lines
2.4 KiB
Groff
103 lines
2.4 KiB
Groff
.\" Man page generated from reStructuredText.
|
|
.
|
|
.TH MIXER.CONFIG 1 "" "" ""
|
|
.SH NAME
|
|
mixer.config \- Perform configuration manipulation actions
|
|
.
|
|
.nr rst2man-indent-level 0
|
|
.
|
|
.de1 rstReportMargin
|
|
\\$1 \\n[an-margin]
|
|
level \\n[rst2man-indent-level]
|
|
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
-
|
|
\\n[rst2man-indent0]
|
|
\\n[rst2man-indent1]
|
|
\\n[rst2man-indent2]
|
|
..
|
|
.de1 INDENT
|
|
.\" .rstReportMargin pre:
|
|
. RS \\$1
|
|
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
|
|
. nr rst2man-indent-level +1
|
|
.\" .rstReportMargin post:
|
|
..
|
|
.de UNINDENT
|
|
. RE
|
|
.\" indent \\n[an-margin]
|
|
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
.nr rst2man-indent-level -1
|
|
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
|
..
|
|
.SH SYNOPSIS
|
|
.sp
|
|
\fBmixer config [command]\fP
|
|
.SH DESCRIPTION
|
|
.sp
|
|
Perform various configuration manipulation actions on the mixer configuration
|
|
files.
|
|
.SH OPTIONS
|
|
.sp
|
|
In addition to the globally recognized \fBmixer\fP flags (see \fBmixer\fP(1) for
|
|
more details), the following options are recognized.
|
|
.INDENT 0.0
|
|
.IP \(bu 2
|
|
\fB\-h, \-\-help\fP
|
|
.sp
|
|
Display \fBconfig\fP help information and exit.
|
|
.UNINDENT
|
|
.SH SUBCOMMANDS
|
|
.sp
|
|
\fBconvert\fP
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
Convert an old config file to the new TOML format. The command will generate
|
|
a backup file of the old config and will replace it with the converted one.
|
|
Environment variables will not be expanded and the values will not be
|
|
validated. In addition to the global options \fBmixer config convert\fP takes
|
|
the following options.
|
|
.INDENT 0.0
|
|
.IP \(bu 2
|
|
\fB\-c, \-\-config {path}\fP
|
|
.sp
|
|
The \fIpath\fP to the configuration file to convert.
|
|
.IP \(bu 2
|
|
\fB\-h, \-\-help\fP
|
|
.sp
|
|
Display \fBconfig convert\fP help and exit.
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.sp
|
|
\fBvalidate\fP
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
Parse a builder config file and display its properties. Properties
|
|
containing environment variables will be expanded. In addition to the
|
|
global options \fBmixer config validate\fP takes the following options.
|
|
.INDENT 0.0
|
|
.IP \(bu 2
|
|
\fB\-c, \-\-config {path}\fP
|
|
.sp
|
|
The \fIpath\fP to the configuration file to validate.
|
|
.IP \(bu 2
|
|
\fB\-h, \-\-help\fP
|
|
.sp
|
|
Display \fBconfig validate\fP help and exit.
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.SH EXIT STATUS
|
|
.sp
|
|
On success, 0 is returned. A non\-zero return code indicates a failure.
|
|
.SS SEE ALSO
|
|
.INDENT 0.0
|
|
.IP \(bu 2
|
|
\fBmixer\fP(1)
|
|
.UNINDENT
|
|
.SH COPYRIGHT
|
|
(C) 2018 Intel Corporation, CC-BY-SA-3.0
|
|
.\" Generated by docutils manpage writer.
|
|
.
|