2016-09-18 17:02:59 +02:00
<?xml version='1.0'?> <!-- * - nxml - * -->
< !DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2016-09-30 18:34:55 +02:00
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
2016-09-18 17:02:59 +02:00
<!--
2016-09-30 18:34:55 +02:00
This file is part of manjaro-tools.
2016-09-18 17:02:59 +02:00
2016-09-30 18:34:55 +02:00
Copyright 2015 Manjaro Developers
2016-09-18 17:02:59 +02:00
2016-09-30 18:34:55 +02:00
manjaro-tools is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
2016-09-18 17:02:59 +02:00
2016-09-30 18:34:55 +02:00
manjaro-tools is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
2016-09-18 17:02:59 +02:00
2016-09-30 18:34:55 +02:00
You should have received a copy of the GNU Lesser General Public License
along with systemd; If not, see <http: / / w w w . g n u . o r g / l i c e n s e s /> .
2016-09-18 17:02:59 +02:00
-->
<refentry id= "check-yaml" xmlns:xi= "http://www.w3.org/2001/XInclude" >
2016-09-30 18:34:55 +02:00
<refentryinfo >
<title > check-yaml-+</title>
<productname > manjaro-tools</productname>
2016-09-18 17:02:59 +02:00
2016-09-30 18:34:55 +02:00
<authorgroup >
<author >
<contrib > </contrib>
<firstname > </firstname>
<surname > </surname>
<email > </email>
</author>
</authorgroup>
</refentryinfo>
2016-09-18 17:02:59 +02:00
2016-09-30 18:34:55 +02:00
<refmeta >
<refentrytitle > check-yaml</refentrytitle>
<manvolnum > 1</manvolnum>
</refmeta>
2016-09-18 17:02:59 +02:00
2016-09-30 18:34:55 +02:00
<refnamediv >
<refname > check-yaml</refname>
<refpurpose > check-yaml is used to generate and validate yaml files used by calamares. </refpurpose>
</refnamediv>
2016-09-18 17:02:59 +02:00
2016-09-30 18:34:55 +02:00
<refsynopsisdiv >
<cmdsynopsis >
<command > check-yaml</command>
<arg choice= "opt" rep= "repeat" > OPTIONS</arg>
</cmdsynopsis>
</refsynopsisdiv>
2016-09-18 17:02:59 +02:00
2016-09-30 18:34:55 +02:00
<refsect1 >
<title > Description</title>
2016-09-18 17:02:59 +02:00
2016-09-30 18:34:55 +02:00
<para > <command > check-yaml</command> is used to generate and validate yaml files used by calamares.</para>
2016-09-18 17:02:59 +02:00
2016-09-30 18:34:55 +02:00
<para > check-yaml is a script to generate and validate yaml files by yaml schemas. Buildiso generates these files also, but check-yaml is a standalone version without the need to build the entire iso.</para>
2016-09-18 17:02:59 +02:00
2016-09-30 18:34:55 +02:00
</refsect1>
2016-09-18 17:02:59 +02:00
2016-09-30 18:34:55 +02:00
<refsect1 >
<title > Options</title>
2016-09-18 17:02:59 +02:00
2016-09-30 18:34:55 +02:00
<para > The following options are understood:</para>
2016-09-18 17:02:59 +02:00
2016-09-30 18:34:55 +02:00
<variablelist >
<varlistentry >
<term > <option > -p PROFILE...</option> </term>
2016-09-18 17:02:59 +02:00
2016-09-30 18:34:55 +02:00
<listitem > <para > Name of the build list or name of the directory.</para> </listitem>
</varlistentry>
2016-09-18 17:02:59 +02:00
<varlistentry >
2016-09-30 18:34:55 +02:00
<term > <option > -a i686|x86_64</option> </term>
2016-09-18 17:02:59 +02:00
2016-09-30 18:34:55 +02:00
<listitem > <para > Architecture that the yaml will be created for. Can be i686 or x86_64.</para> </listitem>
</varlistentry>
2016-09-18 17:02:59 +02:00
<varlistentry >
2016-09-30 18:34:55 +02:00
<term > <option > -i systemd|openrc</option> </term>
2016-09-18 17:02:59 +02:00
2016-09-30 18:34:55 +02:00
<listitem > <para > The init system the yaml will be created for.</para> </listitem>
</varlistentry>
2016-09-18 17:02:59 +02:00
<varlistentry >
2016-09-30 18:34:55 +02:00
<term > <option > -k linuxXXX</option> </term>
2016-09-18 17:02:59 +02:00
2016-09-30 18:34:55 +02:00
<listitem > <para > The kernel the yaml will be created for.</para> </listitem>
</varlistentry>
2016-09-18 17:02:59 +02:00
2016-09-30 18:34:55 +02:00
<varlistentry >
<term > <option > -c</option> </term>
2016-09-18 17:02:59 +02:00
2016-09-30 18:34:55 +02:00
<listitem > <para > Create calamares yaml conf files.</para> </listitem>
</varlistentry>
2016-09-18 17:02:59 +02:00
2016-09-30 18:34:55 +02:00
<varlistentry >
<term > <option > -g</option> </term>
2016-09-18 17:02:59 +02:00
2016-09-30 18:34:55 +02:00
<listitem > <para > Generate a packman group netgroup yaml file.</para> </listitem>
</varlistentry>
2016-09-18 17:02:59 +02:00
2016-09-30 18:34:55 +02:00
<varlistentry >
<term > <option > -v</option> </term>
2016-09-18 17:02:59 +02:00
2016-09-30 18:34:55 +02:00
<listitem > <para > Validate the yaml file by yaml schema.</para> </listitem>
</varlistentry>
2016-09-18 17:02:59 +02:00
2016-09-30 18:34:55 +02:00
<varlistentry >
<term > <option > -q</option> </term>
2016-09-18 17:02:59 +02:00
2016-09-30 18:34:55 +02:00
<listitem > <para > Query settings.</para> </listitem>
</varlistentry>
2016-09-18 17:02:59 +02:00
2016-09-30 18:34:55 +02:00
<varlistentry >
<term > <option > -h</option> </term>
2016-09-18 17:02:59 +02:00
2016-09-30 18:34:55 +02:00
<listitem > <para > Help.</para> </listitem>
</varlistentry>
</variablelist>
2016-09-18 17:02:59 +02:00
2016-09-30 18:34:55 +02:00
</refsect1>
2016-09-18 17:02:59 +02:00
2016-09-30 18:34:55 +02:00
<!-- <refsect1>
<title > Exit status</title>
2016-09-18 17:02:59 +02:00
2016-09-30 18:34:55 +02:00
<para > On success, 0 is returned, a non-zero failure code
otherwise.</para>
</refsect1>
-->
2016-09-18 17:02:59 +02:00
2016-09-30 18:34:55 +02:00
<refsect1 >
<title > See Also</title>
<para >
<citerefentry project= 'manjaro-tools' > <refentrytitle > manjaro-tools.conf</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> ,
<citerefentry project= 'manjaro-tools' > <refentrytitle > profiles.conf</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> ,
</para>
</refsect1>
2016-09-18 17:02:59 +02:00
</refentry>