Files
Reagan Lopez fc222fdb05 Update man page
Update man page to include `format` flag.

Also, update Makefile to build man pages as a prerequisite for the
`build` target.

Fixes #557

Signed-off-by: Reagan Lopez <reagan.lopez@intel.com>
2020-04-27 09:55:02 -07:00

107 lines
2.6 KiB
Groff

.\" Man page generated from reStructuredText.
.
.TH MIXER.INIT 1 "" "" ""
.SH NAME
mixer.init \- Initialize mixer and workspace
.
.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 init [flags]\fP
.SH DESCRIPTION
.sp
Initialize the mixer configuration and mixer workspace by writing default
configuration files if necessary and building the proper directory structure.
.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\-\-all\-local\fP
.sp
Initialize mix with all local bundles automatically included.
.IP \(bu 2
\fB\-\-all\-upstream\fP
.sp
Initialize the mix with all upstream bundles automatically included.
.IP \(bu 2
\fB\-\-clear\-version {version}\fP
.sp
Upstream version used to compose the mix. It must be either an integer or \(aqlatest\(aq (default "latest")
.IP \(bu 2
\fB\-\-config {path}\fP
.sp
Supply a specific configuration file at \fIpath\fP to use for mixing.
.IP \(bu 2
\fB\-\-format {format}\fP
.sp
Supply the format version for the mix.
.IP \(bu 2
\fB\-\-git\fP
.sp
Track mixer\(aqs internal work directory with git.
.IP \(bu 2
\fB\-h, \-\-help\fP
.sp
Display \fBinit\fP help information and exit.
.IP \(bu 2
\fB\-\-local\-rpms\fP
.sp
Create and configure local RPM directories.
.IP \(bu 2
\fB\-\-mix\-version {version}\fP
.sp
Supply the mix version to build (default is 10)
.IP \(bu 2
\fB\-\-no\-default\-bundles\fP
.sp
Skip adding default bundles to the mix
.IP \(bu 2
\fB\-\-upstream\-url {url}\fP
.sp
Supply an upstream URL to use for mixing (default is
"\fI\%https://download.clearlinux.org\fP")
.IP \(bu 2
\fB\-\-upstream\-version {version}\fP
.sp
Alias to \fI\-\-clear\-version\fP (default is "latest")
.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.
.